{"id":15192485,"url":"https://github.com/jimzhan/base.js","last_synced_at":"2026-03-04T19:31:55.276Z","repository":{"id":287364816,"uuid":"958959258","full_name":"jimzhan/base.js","owner":"jimzhan","description":"An opinionated API service startup kit with a set of best practices.","archived":false,"fork":false,"pushed_at":"2025-04-11T09:59:06.000Z","size":1378,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-26T07:43:57.334Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jimzhan.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,"zenodo":null}},"created_at":"2025-04-02T03:25:43.000Z","updated_at":"2025-04-11T09:59:09.000Z","dependencies_parsed_at":"2025-04-12T10:45:59.856Z","dependency_job_id":null,"html_url":"https://github.com/jimzhan/base.js","commit_stats":null,"previous_names":["jimzhan/base.js"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jimzhan/base.js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fbase.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fbase.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fbase.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fbase.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jimzhan","download_url":"https://codeload.github.com/jimzhan/base.js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fbase.js/sbom","scorecard":{"id":521017,"data":{"date":"2025-08-11","repo":{"name":"github.com/jimzhan/base.js","commit":"c72855cf20e4116d702958a41447d782f799a5e1"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/13 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":"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":"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":"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":"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":"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: 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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"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":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-xffm-g5w8-qvg7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-859w-5945-r5v3"],"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-20T03:00:24.563Z","repository_id":287364816,"created_at":"2025-08-20T03:00:24.563Z","updated_at":"2025-08-20T03:00:24.563Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30090525,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T18:31:08.343Z","status":"ssl_error","status_checked_at":"2026-03-04T18:31:07.708Z","response_time":59,"last_error":"SSL_read: 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":["biolerplate","koajs","pm2","prototype","server","skeleton"],"created_at":"2024-09-27T21:40:57.443Z","updated_at":"2026-03-04T19:31:55.256Z","avatar_url":"https://github.com/jimzhan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"We :revolving_hearts: Koa.js\n================================\n[![dependencies](https://david-dm.org/jimzhan/base.js.svg)](https://david-dm.org/jimzhan/base.js.svg)\n[![build](https://travis-ci.org/jimzhan/base.js.svg?branch=master)](https://travis-ci.org/jimzhan/base.js)\n[![npm version](https://img.shields.io/npm/v/base.js.svg?style=flat-square)](https://www.npmjs.com/package/base.js)\n[![npm downloads](https://img.shields.io/npm/dm/base.js.svg?style=flat-square)](https://www.npmjs.com/package/base.js)\n\nProduction application boilerplate for Koa, batteries included:\n+ ES6 + Babel\n+ [ESLint](https://github.com/eslint/eslint) with the [Airbnb JavaScript](https://github.com/airbnb/javascript) rules.\n+ [ApiDoc](http://apidocjs.com/) creates a documentation from API annotations in your source code.\n+ [Mocha](https://github.com/mochajs/mocha) Unit testing and coverage with [Chai](https://github.com/chaijs/chai) assertion framework.\n+ [Editorconfig](http://editorconfig.org/) Consistent coding styles formatter.\n+ [Yarn](https://yarnpkg.com/en/) Dependency management.\n+ [Koa.js](https://github.com/koajs/koa) Next generation web framework.\n+ [Dotenv](https://github.com/motdotla/dotenv) Production settings profile solution.\n+ [JSON Web Tokens](https://jwt.io/) Industry standard RFC 7519 method for representing claims securely between two parties.\n\n## Key NPM Scripts\n* `npm start` - start Koa with hot reload supports (default port `3000`).\n* `npm run docs` - generate API docs in `docs` folder (ignored by git) \u0026 start serving.\n\n## Batteries included\n* configurable prefixed server endpoint (`/v1` by default).\n* JWT based authentication.\n* common middleware.\n* intelligent/automatic config registration.\n* intelligent/automatic routes registration.\n\n  Module created under `apps` folder with routes defined in `index.js` will be registered onto server router automatically.\n```javscript\n// OPTIONAL prefix definition, by default, system will register the module name as its routing prefix.\n//  `prefix -\u003e false` will disable prefix for this module.\nexport const prefix = '/\u003cmodule-prefix\u003e';\n\nimport * as mw from './middleware';\nimport * as views from './views';\n\nexport default {\n  'GET /', views.list,\n  'GET /:key', views.get,\n  'POST /', [mw.acl, views.create],\n  'PUT  /:key', views.update,\n  'DELETE /:key', views.delete,\n}\n```\n* module alias support\n\n```javascript\n// Use this:\nimport MyUtilFn from 'utils/MyUtilFn';\n// Instead of that:\nimport MyUtilFn from '../../../../utils/MyUtilFn';\n```\n\nTODOs\n=====\n- [x] ESLint rules supports.\n- [x] NPM scripts for common operations.\n- [x] `dotenv` based multi settings profiles at server side.\n- [x] Grouped routing system.\n- [x] Grouped settings system.\n- [x] unit test integration.\n- [x] hot reload koa server.\n- [ ] PM2 ecosystem integration.\n- [ ] common helpers.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimzhan%2Fbase.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjimzhan%2Fbase.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimzhan%2Fbase.js/lists"}