Coversy

Instructor shift scheduling, shift exchange, and payroll management system.

Deployments

• Application
• API
• Documentation

Prerequisites

This project requires NodeJS (version 16 or later) and NPM. Node and NPM. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v

Installation

Install dependencies:

$ npm install

Configuration

Create copies of the .env.example files (/server, /client) and rename them to '.env'.
Update the copies with your database credentials and other configuration options.

Development

Run development client & server:

$ npm run dev

Documentation

To generate jsdocs:

$ npm run doc

Troubleshooting

Check that you have the latest version of NodeJS and NPM.
Check to ensure that environment variables are set correctly.