update readme

This commit is contained in:
Erik 2022-11-09 14:56:55 +02:00
parent 05503ade05
commit 1bb2421e9d
Signed by: Navy.gif
GPG Key ID: 811EC0CD80E7E5FB
3 changed files with 15 additions and 3 deletions

View File

@ -1,5 +1,6 @@
# Navy's webserver framework
A template repository for creating Node.js based webservers with sharding.
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`
@ -9,4 +10,11 @@ Master process, orchestrates the whole program. Takes care of starting up the sh
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.
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.

View File

@ -16,7 +16,6 @@
"customColors": {"access": "green", "unauthorised": "red"}
},
"discord": {
"id": "955399395740905482",
"scope": ["identify"],
"version": 10
},

View File

@ -1,3 +1,8 @@
/**
*
* @abstract
* @class AbstractUserDatabase
*/
class AbstractUserDatabase {
fetchUser () {