Getting started

Last updated 2 months ago

Setting up the web server

npm version Build Status codecov

Overview

The SugoiJS server module provides express based web server, thanks to inversify-express-utils.

This module contain utils for singleton services, request handling decorators, request policies and authorization policies decorators.

This module helps you define microservices by using module based architecture.

Installation

@sugoi/cli

Check the get started section and jump directly to "Define a route" section

Manually

npm install --save @sugoi/server

tsconfig.json:

Under your tsconfig - compilerOptions set:

  • "target": "es2015"

  • "emitDecoratorMetadata": true

  • "experimentalDecorators": true

  • "lib": ["es2015","dom"]

Template

You can use the config template that was set for the @sugoi/demo application:

{
"compilerOptions": {
"baseUrl": "./src",
"allowJs": true,
"target": "es2015",
"module": "commonjs",
"moduleResolution": "node",
"sourceMap": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"lib": [
"es2015",
"dom"
],
"typeRoots": [
"./node_modules/@types"
],
"types": [
"body-parser",
"express",
"node"
]
}
}