Giter Club home page Giter Club logo

base.js's Introduction

We ๐Ÿ’ž Koa.js

dependencies build npm version npm downloads

Production application boilerplate for Koa, batteries included:

  • ES6 + Babel
  • ESLint with the Airbnb JavaScript rules.
  • ApiDoc creates a documentation from API annotations in your source code.
  • Mocha Unit testing and coverage with Chai assertion framework.
  • Editorconfig Consistent coding styles formatter.
  • Yarn Dependency management.
  • Koa.js Next generation web framework.
  • Dotenv Production settings profile solution.
  • JSON Web Tokens Industry standard RFC 7519 method for representing claims securely between two parties.

Key NPM Scripts

  • npm start - start Koa with hot reload supports (default port 3000).
  • npm run docs - generate API docs in docs folder (ignored by git) & start serving.

Batteries included

  • configurable prefixed server endpoint (/v1 by default).

  • JWT based authentication.

  • common middleware.

  • intelligent/automatic config registration.

  • intelligent/automatic routes registration.

    Module created under apps folder with routes defined in index.js will be registered onto server router automatically.

// OPTIONAL prefix definition, by default, system will register the module name as its routing prefix.
//  `prefix -> false` will disable prefix for this module.
export const prefix = '/<module-prefix>';

import * as mw from './middleware';
import * as views from './views';

export default {
  'GET /', views.list,
  'GET /:key', views.get,
  'POST /', [mw.acl, views.create],
  'PUT  /:key', views.update,
  'DELETE /:key', views.delete,
}
  • module alias support
// Use this:
import MyUtilFn from 'utils/MyUtilFn';
// Instead of that:
import MyUtilFn from '../../../../utils/MyUtilFn';

TODOs

  • ESLint rules supports.
  • NPM scripts for common operations.
  • dotenv based multi settings profiles at server side.
  • Grouped routing system.
  • Grouped settings system.
  • unit test integration.
  • hot reload koa server.
  • PM2 ecosystem integration.
  • common helpers.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.