@kites/core
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.1 • Public • Published

    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.

    Features

    • [x] Extension as a feature
    • [x] Autodiscover extensions
    • [x] Rich decorators system
    • [x] Event-driven programming
    • [ ] Reactive programming
    • [ ] Storage mutiple providers
    • [ ] Micro frontends development

    Installation

    # install kites cli
    $ npm install -g @kites/cli
    
    # init a project
    kites init my-project
    
    # move to project workspace
    cd my-project
    
    # install dependencies
    npm install
    
    # start development
    npm start

    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.

    Example

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

    TypeScript version:

    import {engine} from '@kites/core';
    
    async function bootstrap() {
      const app = await engine().init();
      app.logger.info('Hello World!');
    }
    
    bootstrap();

    JavaScript version:

    const kites = require('@kites/core');
    
    kites.engine().init().then((app) => {
      app.logger.info('Hello World!');
    });

    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.

    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 {engine} from '@kites/core';
    
    async function bootstrap() {
      // let kites autodiscover the extensions
      const app = await engine({ discover: 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 {engine} from '@kites/core';
    import express from '@kites/express';
    
    async function bootstrap() {
      const app = await engine({
          discover: false,
        })
        .use(express())
        .on('express:config', app => {
          app.get('/hi', (req, res) => res.send('hello!'));
        })
        .init();
    
      app.logger.info(`Let's browse http://localhost:3000/hi`);
    }
    
    // let kites fly!
    bootstrap();

    Templates

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

    • [x] starter: Kites Project Starter with Typescript (default)
    • [x] docsify: Template webserver for documentation site generator
    • [x] chatbot: Template for generating an AI Chatbot

    More templates, checkout issue #1.

    Documentation

    License

    MIT License

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

    The MIT License

    Install

    npm i @kites/core

    DownloadsWeekly Downloads

    7

    Version

    1.3.1

    License

    MIT

    Unpacked Size

    62.5 kB

    Total Files

    47

    Last publish

    Collaborators

    • vunb