{"id":21601502,"url":"https://github.com/flippingbitss/pma-web-api","last_synced_at":"2025-03-18T13:19:22.859Z","repository":{"id":68236297,"uuid":"129359987","full_name":"flippingbitss/pma-web-api","owner":"flippingbitss","description":"REST api to power the patient monitoring app as part of COMP-308 project","archived":false,"fork":false,"pushed_at":"2018-04-28T18:46:25.000Z","size":147,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-24T18:28:11.166Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flippingbitss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-13T06:41:02.000Z","updated_at":"2018-04-28T18:46:27.000Z","dependencies_parsed_at":"2023-07-26T23:31:13.206Z","dependency_job_id":null,"html_url":"https://github.com/flippingbitss/pma-web-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flippingbitss%2Fpma-web-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flippingbitss%2Fpma-web-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flippingbitss%2Fpma-web-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flippingbitss%2Fpma-web-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flippingbitss","download_url":"https://codeload.github.com/flippingbitss/pma-web-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244227577,"owners_count":20419263,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T19:09:42.839Z","updated_at":"2025-03-18T13:19:22.852Z","avatar_url":"https://github.com/flippingbitss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## ❯ Table of Contents\n\n- [Getting Started](#-getting-started)\n- [Scripts and Tasks](#-scripts-and-tasks)\n- [API Routes](#-api-routes)\n- [Logging](#-logging)\n- [License](#-license)\n\n\n## ❯ Getting Started\n\n### Step 1: Set up the Development Environment\n\nYou need to set up your development environment before you can do anything.\n\nInstall [Node.js and NPM](https://nodejs.org/en/download/)\n\n- on OSX use [homebrew](http://brew.sh) `brew install node`\n- on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`\n\n### Step 2: Clone the Project\n\nDownload this project\n\nThen copy the `.env.example` file and rename it to `.env`. In this file you have to add your database connection information.\n\nCreate a new database with the name you have in your `.env`-file.\n\nThen setup your application environment.\n\n```bash\nnpm install\n```\n\n\u003e This installs all dependencies. So after that your development environment is ready to use.\n\n### Step 3: Serve your App\n\nGo to the project dir and start your app with this npm script.\n\n```bash\nnpm start serve\n```\n\n\u003e This starts a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.\n\u003e The server address will be displayed to you as `http://0.0.0.0:3000`.\n\n\n## ❯ Scripts and Tasks\n\nAll script are defined in the `package-scripts.js` file, but the most important ones are listed here.\n\n### Install\n\n- Install all dependencies with `npm install`\n\n\n### Running in dev mode\n\n- Run `npm start serve` to start nodemon with ts-node, to serve the app.\n- The server address will be displayed to you as `http://0.0.0.0:3000`\n\n### Building the project and run it\n\n- Run `npm start build` to generated all JavaScript files from the TypeScript sources (There is also a vscode task for this called `build`).\n- To start the builded app located in `dist` use `npm start`.\n\n\n## ❯ API Routes\n\nThe route prefix is `/api` by default, but you can change this in the .env file.\nThe swagger and the monitor route can be altered in the `.env` file.\n\n| Route          | Description |\n| -------------- | ----------- |\n| **/api**       | Shows us the name, description and the version of the package.json |\n| **/swagger**   | This is the Swagger UI with our API documentation |\n| **/monitor**   | Shows a small monitor page for the server |\n| **/api/users** | Example entity endpoint |\n\n\n## ❯ License\n\n[MIT](/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflippingbitss%2Fpma-web-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflippingbitss%2Fpma-web-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflippingbitss%2Fpma-web-api/lists"}