{"id":21580629,"url":"https://github.com/behrad/nestjs-starter","last_synced_at":"2025-06-18T05:38:53.775Z","repository":{"id":42184484,"uuid":"510615037","full_name":"behrad/nestjs-starter","owner":"behrad","description":"NodeJS backend starter kit powered by nestjs","archived":false,"fork":false,"pushed_at":"2022-07-05T07:17:47.000Z","size":246,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-24T14:42:18.669Z","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/behrad.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}},"created_at":"2022-07-05T06:32:13.000Z","updated_at":"2022-07-05T07:18:30.000Z","dependencies_parsed_at":"2022-09-01T14:03:36.140Z","dependency_job_id":null,"html_url":"https://github.com/behrad/nestjs-starter","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/behrad%2Fnestjs-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/behrad%2Fnestjs-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/behrad%2Fnestjs-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/behrad%2Fnestjs-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/behrad","download_url":"https://codeload.github.com/behrad/nestjs-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244181387,"owners_count":20411604,"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-24T14:09:15.792Z","updated_at":"2025-03-18T08:12:42.549Z","avatar_url":"https://github.com/behrad.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Backend\n\nNestjs backend starter kit with authentication\n\n## Installation\n\n```bash\n$ npm install\n```\n\n## Running the app\n\nWe can run the project with or without docker.\n\n### Local\n\nTo run the server without Docker we need this pre-requisite:\n\n- Mongo server running\n- Redis server running\n\nRename `.sample.env` to `.env` and edit it as your needs to configure the app.\n\nCommands\n\n```bash\n# development\n$ npm run start\n\n# watch mode\n$ npm run start:dev\n\n# production mode\n$ npm run start:prod\n```\n\n### Docker\n\n```bash\n# build image\n$ docker build -t backend-api .\n\n# run container from image\n$ docker run -p 3000:3000 --volume 'pwd':/usr/src/app --network --env-file .env backend-api\n\n# run using docker compose\n$ docker-compose up\n```\n\nYou can check out [http://localhost:3000/docs](http://localhost:3000/docs) for available APIs\n\n## Test\n\n```bash\n# unit tests\n$ npm run test\n\n# e2e tests\n$ npm run test:e2e\n\n# test coverage\n$ npm run test:cov\n```\n\n## Contribution Guideline\n\n1.  Clone the Project\n\n        `git clone https://github.com/Fair-Trade-Fares-Ltd/FTF_Backend-API.git`\n\n    - make sure you have `node \u003e= 14` installed\n    - run `npm i` to install dependencies\n    - use docker compose to run dependencies\n    - enable eslint/prettier in your IDE\n\n2.  Create your Feature Branch\n\n        `git checkout -b feature/(task|scope)/AmazingFeature`\n\n3.  Commit your Changes\n\n        `git commit -m 'feat(task|scope): Add some AmazingFeature'`\n\n    Make sure you obey to [commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint) commit message conventions\n\n    ```bash\n    type(scope?): subject\n    body?\n    footer?\n    ```\n\n    `type` must be one of `[build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test]`\n\n4.  Push to the Branch\n    `git push origin feature/(task|scope)/AmazingFeature`\n5.  Open a Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbehrad%2Fnestjs-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbehrad%2Fnestjs-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbehrad%2Fnestjs-starter/lists"}