Getting started

Download

You can now download the release here

You can also fork,clone,download from github for pre release builds and development.

Installation

Before installing, download and install Node.js.

Then copy the example .env file to .env for server and client folders.

$ cp .env.example .env

After you are sure Node.js is installed you can go to each folder (server and client) and run the command below

$ npm i

if your using yarn use this

$ yarn i

Database

This project requires the use of MongoDB for how to install MongoDB you can go here depending on your OS it might differ. Make sure you do the community edtion unless you already have paid for the enterprise version. If you don't want to have to do this you can also follow the docker guide here or signup for MongoDB Cloud here.

Configuration

Testing

$ npm test