{"id":13596359,"url":"https://github.com/danielfsousa/express-rest-boilerplate","last_synced_at":"2025-10-04T10:38:04.873Z","repository":{"id":38252714,"uuid":"97540865","full_name":"danielfsousa/express-rest-boilerplate","owner":"danielfsousa","description":"⌛️ Express starter for building RESTful APIs","archived":false,"fork":false,"pushed_at":"2024-06-30T03:36:43.000Z","size":2074,"stargazers_count":2382,"open_issues_count":39,"forks_count":614,"subscribers_count":53,"default_branch":"main","last_synced_at":"2025-10-02T05:20:13.053Z","etag":null,"topics":["api","boilerplate","docker","es2021","express","express-boilerplate","hacktoberfest","microservices","mongodb","mongoose","nodejs","rest","rest-api","starter"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/danielfsousa.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2017-07-18T01:59:19.000Z","updated_at":"2025-09-28T06:44:08.000Z","dependencies_parsed_at":"2024-05-21T16:05:53.100Z","dependency_job_id":"01f678cc-54c8-492a-9828-5447a3416472","html_url":"https://github.com/danielfsousa/express-rest-boilerplate","commit_stats":{"total_commits":229,"total_committers":21,"mean_commits":"10.904761904761905","dds":0.62882096069869,"last_synced_commit":"b8bed6d7cfce3cf2ef89ec1b5e47b52dfc50e874"},"previous_names":["danielfsousa/express-rest-es2017-boilerplate"],"tags_count":16,"template":true,"template_full_name":null,"purl":"pkg:github/danielfsousa/express-rest-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielfsousa%2Fexpress-rest-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielfsousa%2Fexpress-rest-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielfsousa%2Fexpress-rest-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielfsousa%2Fexpress-rest-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielfsousa","download_url":"https://codeload.github.com/danielfsousa/express-rest-boilerplate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielfsousa%2Fexpress-rest-boilerplate/sbom","scorecard":{"id":319685,"data":{"date":"2025-08-11","repo":{"name":"github.com/danielfsousa/express-rest-boilerplate","commit":"b8bed6d7cfce3cf2ef89ec1b5e47b52dfc50e874"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.4,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/9 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":0,"reason":"dangerous workflow patterns detected","details":["Warn: untrusted code checkout '${{ github.event.workflow_run.head_branch }}': .github/workflows/docker-build-push.yaml:19","Warn: untrusted code checkout '${{ github.event.workflow_run.head_branch }}': .github/workflows/docker-build-push.yaml:47"],"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yaml:1","Warn: no topLevel permission defined: .github/workflows/deploy-render.yaml:1","Warn: no topLevel permission defined: .github/workflows/docker-build-push.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/ci.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/ci.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/ci.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/ci.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-render.yaml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/deploy-render.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-render.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/deploy-render.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-render.yaml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/deploy-render.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-render.yaml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/deploy-render.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-build-push.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/docker-build-push.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-build-push.yaml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/docker-build-push.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-build-push.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/docker-build-push.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-build-push.yaml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/docker-build-push.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-build-push.yaml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/docker-build-push.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-build-push.yaml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/docker-build-push.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-build-push.yaml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/danielfsousa/express-rest-boilerplate/docker-build-push.yaml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating node:8-alpine to node:8-alpine@sha256:38f7bf07ffd72ac612ec8c829cb20ad416518dbb679768d7733c93175453f4d4","Info:   0 out of   7 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   8 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 23 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"73 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-22h7-7wwg-qmgg","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-h452-7996-h45h","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-9j49-mfvp-vmhm","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-8gh8-hqwg-xf34","Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33","Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959","Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-56x4-j7p9-fcf9","Warn: Project is vulnerable to: GHSA-v78c-4p63-2j6c","Warn: Project is vulnerable to: GHSA-f825-f98c-gj3g","Warn: Project is vulnerable to: GHSA-h8hf-x3f4-xwgp","Warn: Project is vulnerable to: GHSA-9m93-w8w6-76hh","Warn: Project is vulnerable to: GHSA-m7xq-9374-9rvx","Warn: Project is vulnerable to: GHSA-vg7j-7cwx-8wgw","Warn: Project is vulnerable to: GHSA-p92x-r36w-9395","Warn: Project is vulnerable to: GHSA-9h6g-pr28-7cqp","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-v923-w3x8-wh69","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-x5gf-qvw8-r2rm","Warn: Project is vulnerable to: GHSA-p493-635q-r6gr","Warn: Project is vulnerable to: GHSA-3965-hpx2-q597","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-gx6r-qc2v-3p3v","Warn: Project is vulnerable to: GHSA-cvv5-9h9w-qp2m","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T01:05:04.066Z","repository_id":38252714,"created_at":"2025-08-18T01:05:04.066Z","updated_at":"2025-08-18T01:05:04.066Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278302556,"owners_count":25964519,"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","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["api","boilerplate","docker","es2021","express","express-boilerplate","hacktoberfest","microservices","mongodb","mongoose","nodejs","rest","rest-api","starter"],"created_at":"2024-08-01T16:02:21.130Z","updated_at":"2025-10-04T10:38:04.843Z","avatar_url":"https://github.com/danielfsousa.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Javascript","Express","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Express ES2017 REST API Boilerplate\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![npm version](https://badge.fury.io/js/express-rest-es2017-boilerplate.svg)](https://badge.fury.io/js/express-rest-es2017-boilerplate) [![Build Status](https://travis-ci.org/danielfsousa/express-rest-es2017-boilerplate.svg?branch=master)](https://travis-ci.org/danielfsousa/express-rest-es2017-boilerplate) [![Coverage Status](https://coveralls.io/repos/github/danielfsousa/express-rest-es2017-boilerplate/badge.svg?branch=master)](https://coveralls.io/github/danielfsousa/express-rest-es2017-boilerplate?branch=master)\n\nBoilerplate/Generator/Starter Project for building RESTful APIs and microservices using Node.js, Express and MongoDB\n\n## Features\n\n - No transpilers, just vanilla javascript\n - ES2017 latest features like Async/Await\n - CORS enabled\n - Uses [yarn](https://yarnpkg.com)\n - Express + MongoDB ([Mongoose](http://mongoosejs.com/))\n - Consistent coding styles with [editorconfig](http://editorconfig.org)\n - [Docker](https://www.docker.com/) support\n - Uses [helmet](https://github.com/helmetjs/helmet) to set some HTTP headers for security\n - Load environment variables from .env files with [dotenv](https://github.com/rolodato/dotenv-safe)\n - Request validation with [joi](https://github.com/hapijs/joi)\n - Gzip compression with [compression](https://github.com/expressjs/compression)\n - Linting with [eslint](http://eslint.org)\n - Tests with [mocha](https://mochajs.org), [chai](http://chaijs.com) and [sinon](http://sinonjs.org)\n - Code coverage with [istanbul](https://istanbul.js.org) and [coveralls](https://coveralls.io)\n - Git hooks with [husky](https://github.com/typicode/husky) \n - Logging with [morgan](https://github.com/expressjs/morgan)\n - Authentication and Authorization with [passport](http://passportjs.org)\n - API documentation generation with [apidoc](http://apidocjs.com)\n - Continuous integration support with [travisCI](https://travis-ci.org)\n - Monitoring with [pm2](https://github.com/Unitech/pm2)\n\n## Requirements\n\n - [Node v7.6+](https://nodejs.org/en/download/current/) or [Docker](https://www.docker.com/)\n - [Yarn](https://yarnpkg.com/en/docs/install)\n\n## Getting Started\n\n#### Clone the repo and make it yours:\n\n```bash\ngit clone --depth 1 https://github.com/danielfsousa/express-rest-es2017-boilerplate\ncd express-rest-es2017-boilerplate\nrm -rf .git\n```\n\n#### Install dependencies:\n\n```bash\nyarn\n```\n\n#### Set environment variables:\n\n```bash\ncp .env.example .env\n```\n\n## Running Locally\n\n```bash\nyarn dev\n```\n\n## Running in Production\n\n```bash\nyarn start\n```\n\n## Lint\n\n```bash\n# lint code with ESLint\nyarn lint\n\n# try to fix ESLint errors\nyarn lint:fix\n\n# lint and watch for changes\nyarn lint:watch\n```\n\n## Test\n\n```bash\n# run all tests with Mocha\nyarn test\n\n# run unit tests\nyarn test:unit\n\n# run integration tests\nyarn test:integration\n\n# run all tests and watch for changes\nyarn test:watch\n\n# open nyc test coverage reports\nyarn coverage\n```\n\n## Validate\n\n```bash\n# run lint and tests\nyarn validate\n```\n\n## Logs\n\n```bash\n# show logs in production\npm2 logs\n```\n\n## Documentation\n\n```bash\n# generate and open api documentation\nyarn docs\n```\n\n## Docker\n\n```bash\n# run container locally\nyarn docker:dev\n\n# run container in production\nyarn docker:prod\n\n# run tests\nyarn docker:test\n```\n\n## Deploy\n\nSet your server ip:\n\n```bash\nDEPLOY_SERVER=127.0.0.1\n```\n\nReplace my Docker username with yours:\n\n```bash\nnano deploy.sh\n```\n\nRun deploy script:\n\n```bash\nyarn deploy\n```\n\n## Tutorials\n - [Create API Documentation Using Squarespace](https://selfaware.blog/home/2018/6/23/api-documentation)\n\n## Inspirations\n\n - [KunalKapadia/express-mongoose-es6-rest-api](https://github.com/KunalKapadia/express-mongoose-es6-rest-api)\n - [diegohaz/rest](https://github.com/diegohaz/rest)\n\n## License\n\n[MIT License](README.md) - [Daniel Sousa](https://github.com/danielfsousa)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielfsousa%2Fexpress-rest-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielfsousa%2Fexpress-rest-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielfsousa%2Fexpress-rest-boilerplate/lists"}