webserver-framework/README.md
2022-11-06 19:36:13 +02:00

12 lines
575 B
Markdown

# Navy's webserver framework
A template repository for creating Node.js based webservers with sharding.
## Main components
**Controller:** `/src/controller/Controller.js`
Master process, orchestrates the whole program. Takes care of starting up the shards and communication with them.
**Shard.js:** `/src/controller/Shard.js`
Manages the forked processes. Essentially a wrapper for ChildProcess.
**Server.js:** `/src/server/Server.js`
Main component that runs on the forked processes. Expects a message with a `_start` property with the startup options to be sent.