Skip to content

MHDFahz/NodeJS-Koa-OOP-Serverless-Boilerplate

Repository files navigation


Koa REST API Oops Serverless Boilerplate

Boilerplate for Node.js Koa RESTful API application with Serverless, Cors, Error Handling, Logger, Request Log Time

TECH STACK

NODEJS JEST

KOA-JS koa

Serverless Lambda MVC Architecture


Jest SuperTest


Koa REST API Boilerplate is a highly opinionated boilerplate template for building RESTful API application with Koa.

This boilerplate include the following features:

  • Logging to STDOUT/STDERR stream using
  • A super small and optimized oops structure
  • Swagger API documentation
  • Unit Test and Integration Test along with Test Coverage using Jest testing framework

Getting Started

$ git clone https://github.com/MHDFahz/NodeJS-Koa-OOP-Serverless-Boilerplate.git your-project-name
$ cd your-project-name
$ rm -rf .git && git init
$ npm i
$ npm install

Commands

Run

# Run normally
$ npm run devStart

Test

All test for this boilerplate uses following tools.

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or ask feature requests.

Self Promotion

Like this project? Please give it a ★ on GitHub! It helps this project a lot.

License

Provided under the terms of the MIT License.

Copyright © 2023, Muhammed Fahis.