This repository serves as a backbone at NodeJS HTTP sever projects. It contains auto-generated documentation, payload/parameter checking, dependency injection and many more basic requirements.
You can use Docker to build up every service that this server uses.
To do that run ./run-dev-dockerstack.sh in the project's root directory.
As it is in its name, it should be used only for development purposes.
If you have anything or the server doesn't have any other service dependency use
npm run dev
command.
For production you would like to build your project, which you can do by the
npm run build
command. Webpack is used in this process, you can read its configuration in 'webpack.config.js'
If you would like to add or remove routes to this server, you can do that in the RouteRegistry. The definitions of the routes which are imported in the * * RouteRegistry * * should be placed in the application directory.
For the HTTP server security you must check and adjust ApplicationServerOptions.
The codebase contains code blocks which are commented out for later usage like
- Database
- UserSessionRedisDb and its calling statements.
The application uses the following environment variables:
- ENV # has to be 'production' or 'development'
For the API documentation the hapi's * * swagger * * plugin makes auto-generated interactive descriptions.