{"id":27370022,"url":"https://github.com/pod-point/node-express-api","last_synced_at":"2025-07-04T09:04:57.034Z","repository":{"id":85388064,"uuid":"209088546","full_name":"Pod-Point/node-express-api","owner":"Pod-Point","description":"A template repository for a Node.js API using Express.js and TypeScript.","archived":false,"fork":false,"pushed_at":"2019-12-30T09:56:26.000Z","size":12,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-13T08:56:58.699Z","etag":null,"topics":["node","software-team"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pod-Point.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-09-17T15:19:04.000Z","updated_at":"2023-11-09T00:16:53.000Z","dependencies_parsed_at":"2023-11-09T02:27:39.380Z","dependency_job_id":"9181b449-06d8-41ee-8468-7a7d1b1f0e9b","html_url":"https://github.com/Pod-Point/node-express-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/Pod-Point/node-express-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pod-Point%2Fnode-express-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pod-Point%2Fnode-express-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pod-Point%2Fnode-express-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pod-Point%2Fnode-express-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pod-Point","download_url":"https://codeload.github.com/Pod-Point/node-express-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pod-Point%2Fnode-express-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262151862,"owners_count":23266929,"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":["node","software-team"],"created_at":"2025-04-13T08:47:43.808Z","updated_at":"2025-06-26T22:35:56.737Z","avatar_url":"https://github.com/Pod-Point.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-express-api\n\nA template repository for a Node.js API using Express.js and TypeScript.\n\n## Usage\n\nSee the following link for how to create a repository from a template:\nhttps://help.github.com/en/articles/creating-a-repository-from-a-template\n\n### Installation\n\nTo install the latest version of this templates dependencies, run the following command:\n```bash\nnpm install --save @pod-point/typescript express http-status-codes mysql typeorm express-async-errors @hapi/joi\n```\n\nTo install the latest version of this templates  dev dependencies, run the following command:\n```bash\nnpm install --save-dev @types/express @types/faker @types/jest @types/node @types/supertest concurrently faker jest nodemon sqlite3 supertest ts-jest ts-node tslint tslint-eslint-rules typescript\n```\n\n## Development\n\n### Setup\n\nTo install this applications dependencies, run the following command:\n\n```bash\nnpm install\n```\n\nThis application uses environment variables to define it's database connection. We have setup a `postinstall` script to create an `.env` file from the `.env.example` file, you can then modify the values accordingly for your development environment, this script runs automatically upon running `npm install` but can also be ran by the following command:\n\n```bash\nnpm run postinstall\n```\n\nTo build the docker image run the following command:\n```bash\ndocker-compose build\n```\n\nTo prepare your environment run the following command:\n\n```bash\ndocker-compose up -d\n```\n\n### Database\n\nThis application uses [TypeORM](https://github.com/typeorm/typeorm). To run any TypeORM command uses:\n\n```bash\nnpm run typeorm \u003ccommand\u003e\n```\n\n### Build\n\nThis application uses Typescript. To create a JavaScript build, run the following command:\n\n```bash\nnpm run build\n```\n\n### Linting\n\nThis application uses TSLint. To run the linting for this project, run the following command:\n\n```bash\nnpm run lint\n```\n\n### Testing\n\nThis application uses Jest. To run the test suites for this project, run the following command:\n\n```bash\nnpm run test\n```\n\n### OpenAPI\n\nThis application uses open API. You can [its specifications here](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) and a [live editor here with an example](http://editor.swagger.io/).\n\n### Releases\n\nTBC.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpod-point%2Fnode-express-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpod-point%2Fnode-express-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpod-point%2Fnode-express-api/lists"}