redback-fit-backend

Backend API for Redback Project 3 (Wearables for athletes), built with Python and Flask.

Prerequisites

• Git installed
• Python 3.9+ installed
• Postman installed (optional, for testing endpoints)

Technology Stack

• Framework: Flask
• Database: SQLite (Development)
• Auth: Firebase Auth
• Testing: Postman
• CI/CD: Github Actions

Getting Started

1. Clone the repository to your local machine

   git clone https://github.com/Redback-Operations/redback-fit-backend.git

2. Navigate to the project directory

   cd redback-fit-backend

3. Create a virtual environment

   python -m venv env

4. Activate the virtual environment

   • Windows

     env\Scripts\activate

   • Mac/Linux

     source env/bin/activate

5. Install required dependencies from requirements.txt

   pip install -r requirements.txt

6. Run the Flask server

   python app.py

   The database will be automatically created and initialised on first run found in /instance.

Once running, the backend will be available at:
http://localhost:5000