Skip to content
Template-based Web Application Framework
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

kites

Template-based Web Application Framework

Join the chat at https://gitter.im/nodevn/kites npm version npm downloads Travis

Kites is a framework providing dynamic applications assembling and Template-based extracting. Namely it contains a lot of templates and extensions to help building a new application quickly.

Take a look at this:

@Launcher({
  extensions?: [], // ... kites extensions manually imported here
  discover?: Array<string> | string | boolean; // autodiscover extensions in app's child directories or given path
})
class App {}

Installation

# install kites cli
$ npm install -g @kites/cli

# init a project
kites init my-project --template mvc

# move to project workspace
cd my-project

# install dependencies
npm install

# run app server, navigate browser at http://localhost:3000
npm start

Development environment:

# start project in development mode
npm run dev

To change environment use cmd set NODE_ENV=development or use options your IDE provides. If you don't specify node environment kites assumes development as default.

Simplest Application

The application below simply prints out a greeting: Hello World!

TypeScript version:

import kites from 'kites';

async function bootstrap() {
    const app = await kites().init();
    app.logger.info('Hello World!');
}

bootstrap();

JavaScript version:

const kites = require('kites');

kites().init().then((core) => {
    core.logger.info('Hello World!');
});

Featues

  • Rich decorators system
  • Support front-end development
  • Storage mutiple providers

Documentation

  • See Overview for an overview of concepts, guides and general documentation.
  • See Templates for installation guides how to create a new project based on Kites Templates.

Templates

Here is the list of built-in templates and their implementation status:

  • mvc: Assembling all into complete ship (default)
  • basic: Template for building from scratch
  • apidoc: Template for API Documentation
  • express: Template for Express Application
  • chatbot: Template for generating an AI Chatbot

More templates, checkout issue #1

Extensions

Kites is an eco-system and has many modules which can be assembled into a larger application. You are welcome to write your own extension or even publish it to the community.

Extensions auto discovery

Kites has an option to allow the application auto discover extensions in the directory tree. This means kites will searches for files kites.config.js which describes the extensions and applies all the extensions that are found automatically.

This is fundamental principle for allowing extensions as plugins to be automatically plugged into the system. The application completed with minimalist lines of code, but very powerful!

import kites from 'kites';

async function bootstrap() {
    // let kites autodiscover the extensions
    const app = await kites(true).init();
    app.logger.info('A new kites started!');
}

bootstrap();

Kites extensions auto discovery might slows down the startup and can be explicitly override by using use function. The following code has a slightly complicated configuration for each extension which we want to use.

import express from '@kites/express';
import kites from 'kites';

async function bootstrap() {
    const app = await kites()
        .use(express())
        .on('express:config', app => {
            app.get('/hi', (req, res) => res.send('hello!'));
        })
        .init();

    app.logger.info(`A new kites started! Let's browse http://localhost:3000/hi`);
}

// let kites fly!
bootstrap();

Logging

kites exposes logger property which can be used to adapt the logging as you like. You can for example just add winston console transport and filter in only important log messages into console.

import kites from 'kites';
import { transports } from 'winston';

kites().logger.add(transports.Console, { level: 'info' });

License

MIT License

Copyright (c) 2018 Nhữ Bảo Vũ

The MIT License

You can’t perform that action at this time.