Navy.gif/webserver-framework
Template
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity
Navy's framework for Node.js webservers
17 Commits 1 Branch 0 Tags 6.7 MiB
TypeScript 94.3%
JavaScript 5.7%
9d3fe5f2c2
Go to file Use this template
Navy.gif 9d3fe5f2c2
prepend slash if missing
2022-11-09 16:19:25 +02:00
src prepend slash if missing 2022-11-09 16:19:25 +02:00
.eslintrc.json meta files 2022-11-06 19:36:13 +02:00
.gitignore meta files 2022-11-06 19:36:13 +02:00
index.js meta files 2022-11-09 11:23:54 +02:00
LICENSE meta files 2022-11-09 11:23:54 +02:00
options.json update readme 2022-11-09 14:56:55 +02:00
package.json meta files 2022-11-09 11:23:54 +02:00
README.md update readme 2022-11-09 14:56:55 +02:00
yarn.lock meta files 2022-11-09 11:23:54 +02:00

README.md

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

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.