rideaware/rideaware-api
1
0
Fork 0
Code Issues 15 Pull requests Projects 1 Releases Packages Wiki Activity Actions
No description
37 commits 4 branches 0 tags 164 KiB
Find a file
Blake Ridgway afac3b6281 refactor: Improve server setup and add health check 
Added /health endpoint for monitoring
Improved readability and config setup
Imported auth_bp directly
2025-04-03 10:38:51 -05:00
models feat: Added user profile and creation of profile 2025-02-17 19:46:36 -06:00
routes/user_auth fix: resolve AttributeError in User model and ensure consistent password handling 2025-02-15 22:42:50 -06:00
services/UserService fix: resolve AttributeError in User model and ensure consistent password handling 2025-02-15 22:42:50 -06:00
.gitignore (refactor) boilerplate .gitignore, cleaned up folders 2025-02-15 21:54:25 -06:00
Dockerfile (feat): Dockerfile init 2024-12-20 06:55:59 -06: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 Fixed feedback about the Virtual Training Rides section 2025-01-31 19:22:16 -06: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.