Simple Koa Boilerplate for APIs
Switch branches/tags
Clone or download
Latest commit 80504bd Sep 2, 2018

README.md

Koalerplate

A simple Koa 2 boilerplate for API's using ES6.

GitHub issues GitHub stars GitHub license

KoaJs Slack

What's in the package?

  • Routing with koa-router.
  • Parsing request with koa-bodyparser.
  • CORS middleware with @koa/cors.
  • koa-respond for helper functions on the context.
  • koa-helmet for important security headers.
  • nodemon for development to auto-restart when your files change.
  • dotenv for environment variable management.

Getting Started

git clone https://github.com/dbalas/koalerplate.git
cd koalerplate
mv .env.sample .env
npm run dev // or yarn dev

By default the API server starts on port 3000, http://localhost:3000.

Prerequisites

  • node >= v7.6.0

Contributing

Feel free to submit pull request or suggestions here

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Daniel Balastegui - Initial work - dbalas

License

This project is licensed under the MIT License - see the LICENSE.md file for details