Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pranavpr/koa-api-generator
🚀 Unopinionated Rest API generator using Koa2 & ES2017+ with Jest for testing and ESLint for linting
https://github.com/pranavpr/koa-api-generator
api boilerplate coverage eslint generator jest koa2 koa2-generator nodejs
Last synced: about 17 hours ago
JSON representation
🚀 Unopinionated Rest API generator using Koa2 & ES2017+ with Jest for testing and ESLint for linting
- Host: GitHub
- URL: https://github.com/pranavpr/koa-api-generator
- Owner: pranavpr
- License: mit
- Created: 2017-09-28T08:39:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-30T06:18:18.000Z (over 6 years ago)
- Last Synced: 2025-01-07T17:07:36.009Z (12 days ago)
- Topics: api, boilerplate, coverage, eslint, generator, jest, koa2, koa2-generator, nodejs
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rest API Generator for Koa2
[](https://www.npmjs.com/package/koa-api-generator)
[](https://www.npmjs.com/package/koa-api-generator)
[](https://david-dm.org/pranavpr/koa-api-generator)
[](LICENSE)
A 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.
Make sure you read the FAQ for more details and info.
### Features:
- [Koa](http://koajs.com/) as the web framework.
- ES2017+ support with [Babel](https://babeljs.io/).
- Automatic polyfill requires based on environment with [@babel/preset-env](https://github.com/babel/babel/tree/master/packages/babel-preset-env).
- Linting with [ESLint](http://eslint.org/).
- Testing with [Jest](https://facebook.github.io/jest/).
## Installation
```sh
# Install using npm
npm install -g koa-api-generator
# or if you're using Yarn
yarn add global koa-api-generator
```
## Quick Start
Create the app:
```sh
koa-api /tmp/foo && cd /tmp/foo
```
Install dependencies:
```sh
npm install
# or if you're using Yarn
yarn
```
_If you don't use [Yarn](https://yarnpkg.com/) you can just replace `yarn` with `npm` in the commands that follow._
Then you can begin development:
```sh
yarn run dev
```
This will launch a [nodemon](https://nodemon.io/) process for automatic server restarts when your code changes.
### Testing
Testing 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.
Start the test runner in watch mode with:
```sh
yarn test
```
You can also generate coverage with:
```sh
yarn test --coverage
```
### Linting
Linting 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)).
Begin linting in watch mode with:
```sh
yarn run lint
```
### Environmental variables in development
The 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.
It 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.
### Deployment
Deployment is specific to hosting platform/provider but generally:
```sh
yarn run build
```
will compile your src into `/dist`, and
```sh
yarn start
```
will run `build` (via the `prestart` hook) and start the compiled application from the `/dist` folder.
The last command is generally what most hosting providers use to start your application when deployed, so it should take care of everything.
## FAQ
**Where is all the configuration for ESLint, Jest and Babel?**
In `package.json`. Feel free to extract them in separate respective config files if you like.
**Why are you using `@babel/register` instead of `@babel/node`?**
`@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.
In 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.
## License
MIT License. See the [LICENSE](LICENSE) file.