node-standup v1.0.1

node-standup

Start developing your application fast

Use a set of ready-made tools for quick development of REST API. You have the opportunity to use the following libraries.

• Inversify inversify
• inversify-restify-utils using as router so you could create controller based on documentation.
• swagger-express-ts auto swagger generator.
• configuration-builder pre init config will scan folder, envs and init config module.

#Quick start

npm i node-standup -s

• Create index.ts

import { bootstrap } from 'node-standup'

bootstrap(modules)
.then()

#Options

##Configuration options

options = {
    configOptions: {
        configPath: './config',
        config: {
            boundedContext: 'applicationName', // host/api/v1/{{applicationName}}
            versionApi: 1 // API version 
        }
    },
    onBeforeStartServer: (container) => Promise<void> // hook was stared before server stand up

} 

modules - inversify application modules configPath - path to config folder. By default library will scan ./config folder. boundedContext - application context name. versionApi - API version onBeforeStartServer - hook function that will be executed before server running

##Bootstrap containers

• Logger - // TODO
• RootConfig - Configuration builder get environment variables, ./config folder and compose all configs in IOC container RootConfig.