tgpholly / revolution

Revolution is a modular web server that I made to fit the needs of my projects

What is Revolution?

Revolution is a modular web server, written in node.js and was built with my web projects in mind, but others might find a use in it.

What is Revolution for?

Basically anything web related. As long as you want to try it, it’s probably possible.

How does Revolution work?

Revolution uses a set of modules to handle various functions, there are two modules included with the repo and builds, these being consoleHelper and example_request_handler. consoleHelper is a required module and as such the server will not start without it although nothing is stopping you from making your own module with the module identifier of handle_console, however example_request_handler can be removed without consequence and is there purely to help with module development.

How do modules work?

Modules are loaded in at runtime and are completely separate from each other. Each module has a prefix, for example the request handlers have the prefix “handle_requests” and the consoleHelper has the prefix of "handle_console". These prefixes help the server to determine the function of each module.

How to use Revolution.

From source

git clone https://github.com/tgpholly/Revolution.git
cd Revolution
npm i
node .

How to install modules.

With modules you simply have to place the module inside the modules folder and start the server. The modules will automatically set themselves up and the server will start as normal.

Projects Revolution is used in

EUS

EUS-wiki

revolution's Issues

Rewrite Revolution

This code is a bit bad all around, so probably improve it some time.

Finish readme

Readme is largely unfinished at the moment. Any who would like to do this before I get to this is welcome to do so.
Should include:

• How to setup
• Information on Revolution like how it works e.g how it finds the request handler

consoleHelper only outputs in 24 hour time

12 hour time should be an option in it's config file.

Fix misordered code

Some parts of code in the framework and the included modules are out of order.
This should be fixed.

Check for required modules before starting server

The server has one module that is required for startup currently which is the consoleHelper.
If it's not there it will appear to work but will crash as soon as there is a call to the consoleHelper.
Some checks for this should be added

Add comments to framework

Similar to what was done in EUS I feel that the framework is not commented very well.

Possibly add multi request handler functionality

Currently Revolution only allows the use of a single request handler and if more than one request handler is included in the modules then the last one that was loaded will be used.

This shouldn't be the case and either

• All request handlers that are loaded should be used when a request is taken in
• User should be notified that there are multiple request handlers and the server will be closed.

Either one of these options can be done or if you have your own creative solution feel free to suggest it.