vinarmani/express-template

A template for an express server

Express Template

An express server template with WebSocket (wss:), Swagger UI, and webhook worker support (via Bee Queue).

Installation

Requirements

• Node.js and NPM
• Redis installed and running on your local machine (for Bee Queue support).

Getting Started

In the root directory of this project (the directory containing this README file) run

npm install

This will install the required modules. Then create a new .env file by running

cp sample_env .env

Change the values in the .env file to reflect your settings. You will need to replace the X509 certificate and key values to run on your domain.

To start the application (in developer mode) using nodemon run

sudo npm start

To start the application as a standalone daemon, run

sudo node ./bin/www

With the application started, you can visit http://yourdomain/docs to see this README file.

API Documentation

Documentation is available as a Swagger endpoint by visiting http://yourdomain/api-docs when server is running.