Osseus
Osseus modular web server
Install
$ npm install osseus
after installing update package.json
to include "osseus": "~x.y.z"
instead of "osseus": "^x.y.z"
Osseus Modules
In order to use any one of those modules you should install it on your app
- osseus-config
- osseus-logger
- osseus-mongo
- osseus-mq
- osseus-queue
- osseus-router
- osseus-server
- osseus-wallet
Usage
First, create index.js
:
const Osseus = const main = async { const osseus = await Osseus}
Basic example using CLI configuration
$ node index.js --OSSEUS_SERVER_PORT 8888 --OSSEUS_SERVER_DEPENDENCIES ["'logger'"] --DEBUG true --OSSEUS_LOGGER_LOG_LEVEL debug
For more configuration options see osseus-config
Dependencies
Osseus modules by default are initialized parallely.
In order for modules to initialize after specific modules we have the "dependencies" configuration setting.
Generally speaking, if you wish for one osseus module to initialize before another you'll have to add the following configuration param: OSSEUS_MODULE-1_DEPENDENCIES: ['module-2']
For example, if we wish to have an osseus-server but make sure we have osseus-logger before that we will add to our configuration: OSSEUS_SERVER_DEPENDENCIES: ['logger']
Contributing
Please see contributing guidelines.
License
Code released under the MIT License.