{"id":28860174,"url":"https://github.com/caxy/express-api-starter-kit","last_synced_at":"2025-08-18T07:13:08.602Z","repository":{"id":44495939,"uuid":"194150660","full_name":"caxy/express-api-starter-kit","owner":"caxy","description":null,"archived":false,"fork":false,"pushed_at":"2022-02-10T11:14:08.000Z","size":1040,"stargazers_count":0,"open_issues_count":13,"forks_count":0,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-06-20T04:14:07.979Z","etag":null,"topics":[],"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/caxy.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":"2019-06-27T19:17:00.000Z","updated_at":"2020-04-02T07:51:12.000Z","dependencies_parsed_at":"2022-09-07T19:21:37.023Z","dependency_job_id":null,"html_url":"https://github.com/caxy/express-api-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/caxy/express-api-starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caxy%2Fexpress-api-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caxy%2Fexpress-api-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caxy%2Fexpress-api-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caxy%2Fexpress-api-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caxy","download_url":"https://codeload.github.com/caxy/express-api-starter-kit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caxy%2Fexpress-api-starter-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270957604,"owners_count":24675194,"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-08-18T02:00:08.743Z","response_time":89,"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":[],"created_at":"2025-06-20T04:13:27.603Z","updated_at":"2025-08-18T07:13:08.593Z","avatar_url":"https://github.com/caxy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n## Getting started\n\n```sh\n# Clone the project\ngit clone git@github.com:caxy/express-api-starter-kit.git\ncd express-api-starter-kit\n\n# Make it your own\nrm -rf .git \u0026\u0026 git init \u0026\u0026 yarn init\ncp .env.example .env\n\n# Install dependencies\nyarn install\n\n```\nThen you can begin development:\n\n```sh\nyarn dev\n```\n\nThis will launch a [nodemon](https://nodemon.io/) process for automatic server restarts when your code changes.\n\n### Testing\n\nTesting is powered by [Jest](https://facebook.github.io/jest/). This project also uses [supertest](https://github.com/visionmedia/supertest) for demonstrating a simple routing smoke test suite. Feel free to remove supertest entirely if you don't wish to use it.\n\nStart the test runner in watch mode with:\n\n```sh\nyarn test\n\n```\n\nYou can also generate coverage with:\n\n```sh\nyarn test --coverage\n\n```\n\n### Linting\n\nLinting is set up using [ESLint](http://eslint.org/). It uses ESLint's default [eslint:recommended](https://github.com/eslint/eslint/blob/master/conf/eslint.json) rules. Feel free to use your own rules and/or extend another popular linting config (e.g. [airbnb's](https://www.npmjs.com/package/eslint-config-airbnb) or [standard](https://github.com/feross/eslint-config-standard)).\n\nBegin linting in watch mode with:\n\n```sh\nyarn run lint\n\n```\n\nTo begin linting and start the server simultaneously, edit the `package.json` like this:\n\n```\n\"dev\": \"nodemon src/index.js --exec \\\"node -r dotenv/config -r babel-register\\\" | npm run lint\"\n```\n\n### Environmental variables in development\n\nThe project uses [dotenv](https://www.npmjs.com/package/dotenv) for setting environmental variables during development. Simply copy `.env.example`, rename it to `.env` and add your env vars as you see fit. \n\nIt is **strongly** recommended **never** to check in your .env file to version control. It should only include environment-specific values such as database passwords or API keys used in development. Your production env variables should be different and be set differently depending on your hosting solution. `dotenv` is only for development.\n\n### Deployment\n\nDeployment is specific to hosting platform/provider but generally:\n\n```sh\nyarn build\n\n```\n\n##PM2\n\nA common tool we use for deploying and running node processes is [PM2](http://pm2.keymetrics.io/). \n\nIt used a ecosystem.config.js file to start single or multiple processes in different modes for load balancing.\n\nCopy the .dist as a starting place, any .env variables created should be added here. \n####NOTE. Do not include any Private credentials in the .dist.\n\n```sh\ncp ecosystem.config.js.dist ecosystem.config.js\n\n```\n\nTo start the server, ensure pm2 is installed properly, then run:\n\n```sh\nyarn deploy\n```\n\nThis will install latest packages, build the project, and reload the config in pm2.\nThis command is safe to use with Jenkins deployments.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaxy%2Fexpress-api-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaxy%2Fexpress-api-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaxy%2Fexpress-api-starter-kit/lists"}