Skip to content

Latest commit

 

History

History
56 lines (49 loc) · 2.36 KB

README.md

File metadata and controls

56 lines (49 loc) · 2.36 KB

redback-fit-web

Web application front-end and public-facing website for Redback Project 3 (Wearables for athletes).

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

Optional

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

Getting Started

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

Further documentation

Useful links