rideaware/rideaware-api
1
0
Fork 0
Code Issues 15 Pull requests Projects 1 Releases Packages Wiki Activity Actions
No description
50 commits 4 branches 0 tags 164 KiB
Find a file
Cipher Vance b7a2f2ed4f feat: updated gitignore for migrations
2025-08-28 20:30:58 -05:00
models feat: Added user profile and creation of profile 2025-02-17 19:46:36 -06:00
routes/user_auth fix merge) 2025-04-03 14:52:34 -05:00
services/UserService (refactor): Implement robust logging and database error handling 2025-04-03 10:42:01 -05:00
.dockerignore ci: add docker ignore 2025-08-26 10:39:00 -05:00
.gitignore feat: updated gitignore for migrations 2025-08-28 20:30:58 -05:00
Dockerfile fix(dockerfile): correct env vars, install gunicorn in builder, and improve runtime setup 2025-08-28 20:16:02 -05:00
LICENSE Create LICENSE 2024-12-17 09:57:34 -06:00
README.md (docs): working on readme 2024-12-20 06:56:09 -06:00
requirements.txt (lib): added psycopg2-binary 2025-02-15 18:57:53 -06:00
server.py refactor: Improve server setup and add health check 2025-04-03 10:38:51 -05:00
TODO.md docs(todo): merge RideAware feature blurbs into TODO and fill gaps 2025-08-26 10:07:58 -05:00

README.md

RideAware API

Train with Focus. Ride with Awareness

RideAware API is the backend service for the RideAware platform, providing endpoints for user authentication and structured workout management.

RideAware is a comprehensive cycling training platform designed to help riders stay aware of their performance, progress, and goals.

Whether you're building a structured training plan, analyzing ride data, or completing workouts indoors, RideAware keeps you connected to every detail of your ride.

Getting Started

Prerequisites

Ensure you have the following installed on your system:

  • Docker
  • Python 3.10 or later
  • pip

Setting Up the Project

  1. Clone the Repository

    git clone https://github.com/VeloInnovate/rideaware-api.git
cd rideaware-api

  2. Create a Virtual Environment
    It is recommended to use a Python virtual environment to isolate dependencies.

    python3 -m venv .venv

  3. Activate the Virtual Environment

    • On Linux/Mac: 
      source .venv/bin/activate
    • On Windows: 
      .venv\Scripts\activate

  4. Install Requirements Install the required Python packages using pip:

    pip install -r requirements.txt

Configuration

The application uses environment variables for configuration. Create a .env file in the root directory and define the following variables:

DATABASE=<your_database_connection_string>
  • Replace <your_database_connection_string> with the URI of your database (e.g., SQLite, PostgreSQL).

Running with Docker

To run the application in a containerized environment, you can use the provided Dockerfile.

  1. Build the Docker Image:
docker build -t rideaware-api .
  1. Run the Container
docker run -d -p 5000:5000 --env-file .env rideaware-api

The application will be available at http://127.0.0.1:5000.

Running Tests

To be added.

Contributing

Contributions are welcome! Please create a pull request or open an issue for any improvements or bug fixes.

License

This project is licensed under the AGPL-3.0 License.