Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 2.45 KB

README.md

File metadata and controls

37 lines (32 loc) · 2.45 KB
Raw

Koapi - REST API boilerplate made with Koa.js (v2+)

GitHub license Standard - JavaScript Style Guide Dependency Status Code Climate

Purpose

There is too few projects using the new version of Koa and with a list of updated plugins, dependencies,... This repository is an attempt to create a good and reusable boilerplate for various starting projects in API.
Don't hesitate to send an issue or a pull request to maintain this repository healthy!

features

  • Mongoose - to manage database in Mongo
  • Webpack - to create builds (Uglify.js, Compression plugin)
  • Yarn - for fast installation
  • Eslint + Standard style - Standard style for code consistency
  • Babel - to parse files in es5 + keep sourceMaps
  • Nodemon - to reload automatically the server in development
  • JWT - Authentication and authorization (Soon replaced by Passport.js)
  • bcrypt - Encrypt data such as password
  • Koa-respond - to send responses with specific status
  • Convict to manage configuration
  • koa-helmet - Basic Securities
  • koa-router - Basic routing configuration
  • Basic User model

How to install it?

  • Node >= 7.6 Link to node Latest Features
  • git clone https://github.com/kmathy/Koapi.git
  • yarn (or npm install if you want)
  • npm start to launch server

ROADMAP

To have a global view of our roadmap, see HERE