redback-orion-web

Web application front-end and public-facing website for Redback Project 4 (Project Orion: Crowd Monitoring and Player Tracking).

Prerequisites

Git installed
Node.js installed
IDE or editor of choice (e.g., WebStorm, VS Code)
Terminal of choice (e.g., Git Bash, Command Prompt, WSL, MacOS Terminal)
Web browser
Collaborator access to this repository (if you are a team member)
Git credentials configured on your machine

Recommended

React Dev Tools browser extension for Chrome, Firefox, or Edge

Optional

Git GUI such as GitKraken, SourceTree, GitHub Desktop (if you prefer this over working only with terminal commands)

Getting Started

Clone the repository to your local machine
```
git clone https://github.com/Redback-Operations/redback-orion-web.git
```
(or SSH if you have set up SSH access to your GitHub account)
Create a branch for your work, following the Capstone Branching Guidelines
```
git branch <branch-name>
```
Check out your branch
```
git checkout <branch-name>
```
Open your terminal and navigate to the project directory
```
cd path/to/redback-fit-web
```
Run npm install to install the project dependencies
```
npm install
```
Run npm run dev to start the development server
```
npm run dev
```

Further documentation

Web Project Docs on the Redback company documentation site

Useful links