Navy.gif/webserver-framework
Template
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity
f4a04bc67b
webserver-framework/README.md
Navy.gif b5820dafde
update readme
2022-11-24 00:05:29 +02:00

2.1 KiB
Raw Blame History

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
Frontend: https://git.corgi.wtf/Navy.gif/webserver-framework-frontend

Technologies

  • Argon2
  • Express
  • Passport & related strategies (2FA support)
  • MongoDB & MariaDB

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.
    (Use git remote -v to list remotes)

OAuth callbacks
By default any OAuth callbacks are expected at /api/login/<methodname>, where methodname is the name of the OAuth strategy. E.g. by default this framework has a discord strategy defined in Server.addAuthStrategies which expects a callback to /api/login/discord.

Endpoints
Any all endpoints should go in the /endpoints directory and are expected to inherit from the Endpoint superclass.

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.