| src | ||
| .eslintrc.json | ||
| .gitignore | ||
| index.js | ||
| LICENSE | ||
| options.json | ||
| package.json | ||
| README.md | ||
| yarn.lock | ||
Navy's webserver framework
A template repository for creating Node.js based webservers with sharding.
Main repository: https://git.corgi.wtf/Navy.gif/webserver-framework
How to
Using the template
- Clone the repository
git clone https://git.corgi.wtf/Navy.gif/webserver-framework <project name> - Change the original remote name to
git remote rename origin upstream. - Disable pushing to the upstream remote
git remote set-url --push upstream no_push. - Add your own remote
git remote add <remote name> <repository url>
Fetching the upstream changes
- Fetch the the remotes
git fetch. - Preview the changes
git log -p HEAD..upstream/master - Merge changes to the current branch
git merge upstream/master.
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.
"Lesser" components
Authenticator: /src/server/middleware/Authenticator.js
Takes care of sessions, authentication and authorisation, relies on an implementation of AbstractUserDatabase.js.
UserDatabase: /src/server/components/UserDatabase.js
Implementation of AbstractUserDatabase.js, takes care of user management.