{"id":22378903,"url":"https://github.com/codebrahma/nodejs-backend-boilerplate","last_synced_at":"2026-03-03T17:33:13.838Z","repository":{"id":35912056,"uuid":"158806962","full_name":"Codebrahma/nodejs-backend-boilerplate","owner":"Codebrahma","description":"Node.js Backend boilerplate for rest apis with google oauth authentication","archived":false,"fork":false,"pushed_at":"2023-02-24T21:26:31.000Z","size":233,"stargazers_count":10,"open_issues_count":11,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-01-21T07:17:10.571Z","etag":null,"topics":["chai","circleci","codecov","dotenv","factory-girl","google-oauth2","mocha","mvc","nock","postgresql","rest-api","sentry","sequelize","sinon","vcr"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/Codebrahma.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-11-23T09:02:38.000Z","updated_at":"2024-08-24T08:42:59.000Z","dependencies_parsed_at":"2023-02-13T03:45:28.497Z","dependency_job_id":null,"html_url":"https://github.com/Codebrahma/nodejs-backend-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Codebrahma/nodejs-backend-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codebrahma%2Fnodejs-backend-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codebrahma%2Fnodejs-backend-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codebrahma%2Fnodejs-backend-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codebrahma%2Fnodejs-backend-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Codebrahma","download_url":"https://codeload.github.com/Codebrahma/nodejs-backend-boilerplate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codebrahma%2Fnodejs-backend-boilerplate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30052493,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T15:26:47.567Z","status":"ssl_error","status_checked_at":"2026-03-03T15:26:17.132Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["chai","circleci","codecov","dotenv","factory-girl","google-oauth2","mocha","mvc","nock","postgresql","rest-api","sentry","sequelize","sinon","vcr"],"created_at":"2024-12-04T23:08:18.633Z","updated_at":"2026-03-03T17:33:13.799Z","avatar_url":"https://github.com/Codebrahma.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node.js backend boilerplate\n## Dev environment setup\n\n### Setup Prerequisites\nInstall the below softwares\n\n| S.No        | Software   | Version   | Reference |\n| :---------  | :--------  | :-------  | :-------- |\n| 1           | node       | \u003e= 9.10.0 | [Node.js installation with nvm](https://blog.pm2.io/install-node-js-with-nvm/) |\n| 2           | npm        | \u003e= 6.4.1  | [npm installation](https://www.npmjs.com/get-npm) |\n| 3           | postgresql | \u003e= 10.1   | [PostgreSQL installation](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-16-04) |\n\n### Setup Instructions\n1. Clone the project\n\n    ```shell\n    git clone git@github.com:Codebrahma/nodejs-backend-boilerplate.git\n    ```\n2. Switch your current working directory to the root directory of the project\n\n    ```shell\n    cd nodejs-backend-boilerplate\n    ```\n3. Install the dependencies required by the app and development environment\n\n    ```shell\n    npm install\n    ```\n3. Clone the `config/config.json.example` file. Renamed the cloned file to `config/config.json`\n\n    ```shell\n    cp config/config.json.example config/config.json\n    ```\n4. Open `config/config.json` in your source code editor and update your database credentials for development \u0026 test environments.\n5. Copy the environmental variables for development and test environments\n\n    ```shell\n    cp config/sample.env.example config/development.env\n    cp config/sample.env.example config/test.env\n    ```\n6. Create databases for development and test environments\n\n    ```shell\n    NODE_ENV=development node_modules/.bin/sequelize db:create\n    NODE_ENV=test node_modules/.bin/sequelize db:create\n    ```\n7. Run schema migrations for development and test environments\n\n    ```shell\n    NODE_ENV=development node_modules/.bin/sequelize db:migrate\n    NODE_ENV=test node_modules/.bin/sequelize db:migrate\n    ```\n8. Verify the setup by running the following command. If all the tests pass, then you are good to go. If any tests fail, address your issue by mailing repo maintainers.\n\n    ```shell\n    npm run test\n    ```\n9. Start the server\n\n    ```shell\n    npm start\n    ```\n\n## Developer notes\n\n### To Contribute\n1. Create a new feature branch from `master` branch\n2. Make your contribution or changes\n3. Make sure no test is failing and you have code coverage more than 90% by running `npm run test`\n4. Push your branch to github.com\n5. Raise PR to `staging` from your feature branch.\n6. Make sure `CircleCI` build passes at your feature branch. Your branch will only be merged after the review done by app maintainers.\n7. Assign `ready-for-review` label to your PR once you are done.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodebrahma%2Fnodejs-backend-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodebrahma%2Fnodejs-backend-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodebrahma%2Fnodejs-backend-boilerplate/lists"}