Home - reactor-X/kyrin-express GitHub Wiki

Kyrin-Express

The aim of the project is to automate boilerplate procedures associated with setting up an express application. It solves the problem of structuring node code, without enforcing harsher 'write that code here only' approach. Apart from directory structure required to load the container, developers are free to write and include modules as they see fit.

A typical kyrin-express project directory structure

kyrin-express
└───boot
β”‚   └───www
β”‚       β”‚   www.ts   
β”‚   
└───config
        β”‚   config-dev.yml
        β”‚   config-prod.yml
        β”‚   services.yml
        β”‚   routing.yml
        |   parameters.yml
└───env
        | kyrin-ecosystem.config.json
└───kyrin (contains the framework)
└───src
    └───controllers
        β”‚   ...
    └───model
        β”‚   ...
    └───services
        β”‚   ...
    └───views
          β”‚   ...
└───var
    └───log
        └───dev
        └───prod

β”‚   kyrin.ts
β”‚   package.json    
β”‚   tsconfig.json

Kyrin has a number of configuration files for different components stored in the config directory.

config.yml
Application Name
Logger
Connections
Static Paths (Alias)
Express Middlewares
routing.yml
Controllers
services.yml
Services
parameters.yml
Global Parameters

Click on one of the links on the right to explore more.