Getting Started

Installation

First you need to ensure that you have NodeJS installed.

Node Version Manager (nvm) [Optional]

To easily manage the current version of NodeJS in use on your system NVM is reccomended.

OSX and Linux

The offical NVM repository supports Linux and MacOS. It can be found here.

Windows

While there is no official version of nvm for Windows systems there is another project "nvm-windows" which is intended to bring the same functionality to Windows OS. It can be found here.

NodeJS

If you do not want to use NVM the NodeJS package manager can be found here.

Node Packages

Next all of the required packages must be installed. The web and server directories have different required packages.

Navigate to the web and server directories separately and run

npm install

each time.

Running the Project

Development

Server (Back End)

Simply run the below command in the server directory

npm run dev

This will start a development server with the ts-node and nodemon packages. This allows for easy development via cold-reloading. ts-node allows for running the typescript code without the need for compliation while nodemon monitors for changes to any .ts or .js files.

Flags

Flag	Descriptions
MOCK_DATA	Enables Mock paper data for testing
AUTH_OFF	Disables authentication when set to 'false'

Flags can be called with the following commands

MOCK_DATA=true npm run dev

AUTH_OFF=true npm run dev

MOCK_DATA=true AUTH_OFF=true npm run dev

Testing

Tests are stored in the test/ directory and end with *.test.ts. Testing is done using jest.js and is setup with npm.

To run the current tests run this command from the main top of the project directory

npm test

or

npm run test

React (Front End)

Simply run the below command in the web directory

npm run dev

To start the frontend in production run

npx vite

Production