https://github.com/jimzhan/base.js
An opinionated API service startup kit with a set of best practices.
https://github.com/jimzhan/base.js
biolerplate koajs pm2 prototype server skeleton
Last synced: 4 months ago
JSON representation
An opinionated API service startup kit with a set of best practices.
- Host: GitHub
- URL: https://github.com/jimzhan/base.js
- Owner: jimzhan
- License: apache-2.0
- Created: 2025-04-02T03:25:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-11T09:59:06.000Z (about 1 year ago)
- Last Synced: 2025-08-26T07:43:57.334Z (10 months ago)
- Language: JavaScript
- Size: 1.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
We :revolving_hearts: Koa.js
================================
[](https://david-dm.org/jimzhan/base.js.svg)
[](https://travis-ci.org/jimzhan/base.js)
[](https://www.npmjs.com/package/base.js)
[](https://www.npmjs.com/package/base.js)
Production application boilerplate for Koa, batteries included:
+ ES6 + Babel
+ [ESLint](https://github.com/eslint/eslint) with the [Airbnb JavaScript](https://github.com/airbnb/javascript) rules.
+ [ApiDoc](http://apidocjs.com/) creates a documentation from API annotations in your source code.
+ [Mocha](https://github.com/mochajs/mocha) Unit testing and coverage with [Chai](https://github.com/chaijs/chai) assertion framework.
+ [Editorconfig](http://editorconfig.org/) Consistent coding styles formatter.
+ [Yarn](https://yarnpkg.com/en/) Dependency management.
+ [Koa.js](https://github.com/koajs/koa) Next generation web framework.
+ [Dotenv](https://github.com/motdotla/dotenv) Production settings profile solution.
+ [JSON Web Tokens](https://jwt.io/) Industry standard RFC 7519 method for representing claims securely between two parties.
## Key NPM Scripts
* `npm start` - start Koa with hot reload supports (default port `3000`).
* `npm run docs` - generate API docs in `docs` folder (ignored by git) & start serving.
## Batteries included
* configurable prefixed server endpoint (`/v1` by default).
* JWT based authentication.
* common middleware.
* intelligent/automatic config registration.
* intelligent/automatic routes registration.
Module created under `apps` folder with routes defined in `index.js` will be registered onto server router automatically.
```javscript
// OPTIONAL prefix definition, by default, system will register the module name as its routing prefix.
// `prefix -> false` will disable prefix for this module.
export const prefix = '/';
import * as mw from './middleware';
import * as views from './views';
export default {
'GET /', views.list,
'GET /:key', views.get,
'POST /', [mw.acl, views.create],
'PUT /:key', views.update,
'DELETE /:key', views.delete,
}
```
* module alias support
```javascript
// Use this:
import MyUtilFn from 'utils/MyUtilFn';
// Instead of that:
import MyUtilFn from '../../../../utils/MyUtilFn';
```
TODOs
=====
- [x] ESLint rules supports.
- [x] NPM scripts for common operations.
- [x] `dotenv` based multi settings profiles at server side.
- [x] Grouped routing system.
- [x] Grouped settings system.
- [x] unit test integration.
- [x] hot reload koa server.
- [ ] PM2 ecosystem integration.
- [ ] common helpers.