Skip to content

KOA project starter kit loaded with number of packages.

Notifications You must be signed in to change notification settings

warlock7/koa-starter

Repository files navigation

KOA STARTER TEMPLATE

KOA project starter kit loaded with number of packages.

Installation

  • Clone down the repository.
git clone https://github.com/warlock7/koa-starter.git
  • Install packages.
npm install
  • Create your .env file with reference to .env.example. Edit it to include all your values for the project.

  • Start it up.

npm start

Extras

While koa-starter isn't a framework, I've added a few small extras to make getting your project up and started as easy as possible.

Error Handling

Thrown errors are caught in the error handling middleware in errorHandler.js.

Webpack Config

For build using webpack.

Code Linting and Formatting

Using prettier and eslint for code lint and formatting.

Logging

Using cabin for logging services.

Git commit lint

Using husky and commit lint to lint commit messages.