Development Docs

This documentation is rendered as a website on GitHub Pages. Any change to markdown files will be deployed after it gets merged into the main branch.

Getting Started

The site requires node v16 and npm 8 (which comes installed with node@16) to run locally, since it utilizes workspaces to structure the repo.

If you are already using the Node Version Manager (nvm) tool, you can run nvm install in the directory to get the correct version of node.

Once you have installed node, you can install the project's dependencies:

npm install

Frontend App

• Installation and setup
• Creating a new page
• Creating a component

Backend API

The backend (auth, api, database) is all managed by a separate API outside of this repo.

Automated Testing

• Integration Testing

Authors: Blade Barringer