Koah: A JavaScript repository from eldad87

KOACH

Production ready boilerplate for building APIs with koa2 using mongodb as the database and http/2 as the communication protocol.

Description

This project covers basic necessities of most APIs.

Authentication (passport & jwt)
Database (mongoose)
Testing (mocha)
http/2 support for websites and apis
Doc generation with apidoc
linting using standard

Please note, if you are planning to use this boilerplate for creating a web application then the 'https' protocol should be used to access its pages.

Visit https://localhost:3000/ to access the root page.

Requirements

node > v7.8.0
MongoDB

Installation

git clone https://github.com/SystangoTechnologies/Koach.git

Features

Structure

├── bin
│   └── server.js            # Bootstrapping and entry point
├── cert
│   ├── server.cert          # SSL certificate
│   └── server.key           # SSL certificate key
├── config                   # Server configuration settings
│   ├── env                  # Environment specific config
│   │   ├── common.js
│   │   ├── development.js
│   │   ├── production.js
│   │   └── test.js
│   ├── index.js             # Config entrypoint
│   └── passport.js          # Passportjs config of strategies
├── src                      # Source code
│   ├── modules
│   │   ├── controller.js    # Module-specific controllers
│   │   └── router.js        # Router definitions for module
│   ├── models               # Mongoose models
│   └── middleware           # Custom middleware
│       └── validators       # Validation middleware
└── test                     # Unit tests