/daruk

a node.js web framework based on typescript

Primary LanguageTypeScriptMIT LicenseMIT

daruk web framework for nodejs


NPM version build status PR's Welcome GitHub closed issues npm codecov GitHub top language GitHub code size in bytes Package Quality All Contributors GitHub last commit (branch) Gitter start with why GitHub language count APM Build Status

Daruk

Chinese Document

Daruk is a lightweight web framework base on Koa and written in Typescript. Koa is original http server implementation if you used it. In the daily development,we have to use many open source middleware in Koa to implement scaffold, routing, abstraction and some components such as logging, monitoring, etc.

We can create your web project by Daruk scaffold for business. Daruk core is lightweight and easy extension and learing, but it can provides more options for developer to rapid development such as constraints directory specification and code style.

Daruk, it comes from The Legend of Zelda: Breath of the Wild one of the four heroes, it have symbol of guardian ability. The goal of the framework is also as it.

Daruk is base on Koa2, includes features:

  • Scaffolding
  • Directory and file specification
  • Auto loader and decorator combination
  • Complete Typescript development experience
  • Lifecycle and hook.
  • Custom(performance logs & business logs) & tracked
  • Online performance analysis
  • Lightweight link tracking
  • The MVC development of object-oriented
  • Support the development of the module

Installation scaffolding

# install daruk scaffold cli
$ cnpm i -g daruk-cli

# init project
# --ignore ignore local template cache
$ daruk init --ignore daruk-example

# run the project
$ cd daruk-example
$ npm run dev

Quick start

You can write your code shown below :

import { Daruk } from 'daruk';

const myApp = new Daruk('darukProject', {
  rootPath: __dirname,
  debug: process.env.NODE_ENV === 'dev'
});

myApp.listen(process.env.PORT || 3000);

controllers/index.ts:

import { BaseController, config, Context, Daruk, get, middleware, util } from 'daruk';

export default class Index extends BaseController {
  @util('getToday')
  public getToday: Daruk['util']['getToday'];

  @config('author')
  public author: Daruk['config']['author'];

  @config('version')
  public version: Daruk['config']['version'];

  @middleware('cors')
  @get('/')
  public async index(ctx: Context, next: Function) {
    const weather = await ctx.service.weather.getWeather();
    ctx.body = `Hi, ${this.author}, project version is ${
      this.version
    }, Today is ${this.getToday()}, weather is ${weather}`;
  }
}

More information you can check out example/03-weather.

Docs

More docs: Quick Start

Features Todo

Beta TodoList

How to Contribute

Please let us know how can we help. Do check out issues for bug reports or suggestions first.

To become a contributor, please follow our contributing guide

Contributors

Thanks goes to these wonderful people (emoji key):

xiaojue
xiaojue

πŸ’» 🎨
whale
whale

πŸ’» ⚠️
cuzz
cuzz

πŸ’» ⚠️
ζ‰©ζ•£ζ€§η™ΎδΈ‡η”œι’εŒ…
ζ‰©ζ•£ζ€§η™ΎδΈ‡η”œι’εŒ…

⚠️ πŸ’»
arck.liu
arck.liu

πŸ’» πŸ“–
Manjusaka
Manjusaka

πŸ’»
KenyeeCheung
KenyeeCheung

πŸ’»
ChasLui
ChasLui

πŸ“–
ζœ¨ζ‰
ζœ¨ζ‰

πŸ’»
icepy
icepy

πŸ’»
jeffjing
jeffjing

πŸ’»
yiliang
yiliang

πŸ“–
imakan
imakan

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!