{"id":24350128,"url":"https://github.com/pranavpr/koa-api-generator","last_synced_at":"2026-04-08T23:32:59.942Z","repository":{"id":143882679,"uuid":"105123778","full_name":"pranavpr/koa-api-generator","owner":"pranavpr","description":"🚀 Unopinionated Rest API generator using Koa2 \u0026 ES2017+ with Jest for testing and ESLint for linting","archived":false,"fork":false,"pushed_at":"2018-09-30T06:18:18.000Z","size":17,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-20T01:55:15.250Z","etag":null,"topics":["api","boilerplate","coverage","eslint","generator","jest","koa2","koa2-generator","nodejs"],"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/pranavpr.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-28T08:39:41.000Z","updated_at":"2018-09-30T06:04:14.000Z","dependencies_parsed_at":"2024-02-06T09:01:37.731Z","dependency_job_id":null,"html_url":"https://github.com/pranavpr/koa-api-generator","commit_stats":{"total_commits":7,"total_committers":2,"mean_commits":3.5,"dds":0.1428571428571429,"last_synced_commit":"0fda42dd7c76163fb57dbb783d211ac6373f3f96"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/pranavpr/koa-api-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pranavpr%2Fkoa-api-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pranavpr%2Fkoa-api-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pranavpr%2Fkoa-api-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pranavpr%2Fkoa-api-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pranavpr","download_url":"https://codeload.github.com/pranavpr/koa-api-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pranavpr%2Fkoa-api-generator/sbom","scorecard":{"id":743601,"data":{"date":"2025-08-11","repo":{"name":"github.com/pranavpr/koa-api-generator","commit":"0fda42dd7c76163fb57dbb783d211ac6373f3f96"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/7 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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"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":-1,"reason":"No tokens found","details":null,"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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"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":"Vulnerabilities","score":8,"reason":"2 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h"],"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-22T18:09:22.647Z","repository_id":143882679,"created_at":"2025-08-22T18:09:22.648Z","updated_at":"2025-08-22T18:09:22.648Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31579054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"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":["api","boilerplate","coverage","eslint","generator","jest","koa2","koa2-generator","nodejs"],"created_at":"2025-01-18T13:27:04.041Z","updated_at":"2026-04-08T23:32:59.924Z","avatar_url":"https://github.com/pranavpr.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rest API Generator for Koa2\n\n[![NPM Version](https://img.shields.io/npm/v/koa-api-generator.svg?maxAge=43200)](https://www.npmjs.com/package/koa-api-generator)\n[![NPM Downloads](https://img.shields.io/npm/dt/koa-api-generator.svg?maxAge=43200)](https://www.npmjs.com/package/koa-api-generator)\n[![Dependency Status](https://david-dm.org/pranavpr/koa-api-generator.svg?maxAge=43200)](https://david-dm.org/pranavpr/koa-api-generator)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\nA mostly unopinionated generator for creating Rest APIs using Koa2 and ES2017+ features in a Node.js server environment as well as providing linting and testing support. It provides the setup for compiling, linting and testing your code but doesn't make any further assumptions on how your project should be structured.\n\nMake sure you read the FAQ for more details and info.\n\n### Features:\n\n- [Koa](http://koajs.com/) as the web framework.\n- ES2017+ support with [Babel](https://babeljs.io/).\n- Automatic polyfill requires based on environment with [@babel/preset-env](https://github.com/babel/babel/tree/master/packages/babel-preset-env).\n- Linting with [ESLint](http://eslint.org/).\n- Testing with [Jest](https://facebook.github.io/jest/).\n\n## Installation\n\n```sh\n# Install using npm\nnpm install -g koa-api-generator\n\n# or if you're using Yarn\nyarn add global koa-api-generator\n```\n\n## Quick Start\n\nCreate the app:\n\n```sh\nkoa-api /tmp/foo \u0026\u0026 cd /tmp/foo\n```\n\nInstall dependencies:\n\n```sh\nnpm install\n\n# or if you're using Yarn\nyarn\n```\n\n_If you don't use [Yarn](https://yarnpkg.com/) you can just replace `yarn` with `npm` in the commands that follow._\n\nThen you can begin development:\n\n```sh\nyarn run 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\nYou can also generate coverage with:\n\n```sh\nyarn test --coverage\n```\n\n### Linting\n\nLinting is set up using [ESLint](http://eslint.org/). It uses ESLint's default [eslint:recommended](https://eslint.org/docs/rules/) 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### 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 run build\n```\n\nwill compile your src into `/dist`, and\n\n```sh\nyarn start\n```\n\nwill run `build` (via the `prestart` hook) and start the compiled application from the `/dist` folder.\n\nThe last command is generally what most hosting providers use to start your application when deployed, so it should take care of everything.\n\n## FAQ\n\n**Where is all the configuration for ESLint, Jest and Babel?**\n\nIn `package.json`. Feel free to extract them in separate respective config files if you like.\n\n**Why are you using `@babel/register` instead of `@babel/node`?**\n\n`@babel/node` contains a small \"trap\", it loads Babel's [polyfill](https://babeljs.io/docs/usage/polyfill/) by default. This means that if you use something that needs to be polyfilled, it'll work just fine in development (because `@babel/node` polyfills it automatically) but it'll break in production because it needs to be explicitely included in Babel's CLI which handles the final build.\n\nIn order to avoid such confusions, `@babel/register` is a more sensible approach in keeping the development and production runtimes equal. By using [@babel/preset-env](https://github.com/babel/babel/tree/master/packages/babel-preset-env) only code that's not supported by the running environment is transpiled and any polyfills required are automatically inserted.\n\n## License\n\nMIT License. See the [LICENSE](LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpranavpr%2Fkoa-api-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpranavpr%2Fkoa-api-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpranavpr%2Fkoa-api-generator/lists"}