From e7cc32d25888a3e5f21d1132a71396b4c76566e4 Mon Sep 17 00:00:00 2001 From: Blake Ridgway Date: Fri, 20 Dec 2024 06:44:36 -0600 Subject: [PATCH 1/4] (refactor): Cleaned up requirements to what is only needed --- requirements.txt | 84 +++--------------------------------------------- 1 file changed, 5 insertions(+), 79 deletions(-) diff --git a/requirements.txt b/requirements.txt index 7ad209e..a4bc47e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,79 +1,5 @@ -bcc==0.18.0 -bcrypt==4.2.1 -blinker==1.9.0 -Brlapi==0.8.3 -certifi==2020.6.20 -chardet==4.0.0 -chrome-gnome-shell==0.0.0 -click==8.1.7 -colorama==0.4.4 -command-not-found==0.3 -cryptography==3.4.8 -cupshelpers==1.0 -dbus-python==1.2.18 -defer==1.0.6 -distro==1.7.0 -evdev==1.4.0 -Flask==3.1.0 -Flask-Bcrypt==1.0.1 -Flask-SQLAlchemy==3.1.1 -greenlet==3.1.1 -hidpidaemon==18.4.6 -httplib2==0.20.2 -idna==3.3 -importlib-metadata==4.6.4 -itsdangerous==2.2.0 -jeepney==0.7.1 -Jinja2==3.1.4 -kernelstub==3.1.4 -keyring==23.5.0 -language-selector==0.1 -launchpadlib==1.10.16 -lazr.restfulclient==0.14.4 -lazr.uri==1.0.6 -libvirt-python==8.0.0 -louis==3.20.0 -macaroonbakery==1.3.1 -MarkupSafe==3.0.2 -more-itertools==8.10.0 -msgpack==1.1.0 -netaddr==0.8.0 -netifaces==0.11.0 -oauthlib==3.2.0 -pop-transition==1.1.2 -protobuf==3.12.4 -pycairo==1.20.1 -pycups==2.0.1 -pydbus==0.6.0 -PyGObject==3.42.1 -PyJWT==2.3.0 -pymacaroons==0.13.0 -PyNaCl==1.5.0 -pynvim==0.5.2 -pyparsing==2.4.7 -pyRFC3339==1.1 -python-apt==2.4.0+ubuntu4 -python-debian==0.1.43+ubuntu1.1 -python-gnupg==0.4.8 -python-xlib==0.29 -pytz==2022.1 -pyxdg==0.27 -PyYAML==5.4.1 -repolib==2.2.1 -repoman==1.4.0 -requests==2.25.1 -SecretStorage==3.3.1 -sessioninstaller==0.0.0 -six==1.16.0 -SQLAlchemy==2.0.36 -system76driver==20.4.102 -systemd-python==234 -typing_extensions==4.12.2 -ubuntu-drivers-common==0.0.0 -ufw==0.36.1 -urllib3==1.26.5 -wadllib==1.3.6 -Werkzeug==3.1.3 -xdg==5 -xkit==0.0.0 -zipp==1.0.0 +Flask +sqlalchemy +flask_bcrypt +flask_sqlalchemy +python-dotenv \ No newline at end of file From 5e19f9a7899f6294ecf5f119f3ea8c959b429801 Mon Sep 17 00:00:00 2001 From: Blake Ridgway Date: Fri, 20 Dec 2024 06:55:59 -0600 Subject: [PATCH 2/4] (feat): Dockerfile init --- Dockerfile | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..a1dff73 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +FROM python:3.10-slim + +WORKDIR /app +COPY requirements.txt . + +RUN pip install --no-cache-dir -r requirements.txt +COPY . . + +EXPOSE 5000 + +ENV FLASK_APP=server.py +ENV FLASK_RUN_HOST=0.0.0.0 + +CMD ["flask", "run"] From ecbbd8300511d2237b8b8b521979d065c5acf396 Mon Sep 17 00:00:00 2001 From: Blake Ridgway Date: Fri, 20 Dec 2024 06:56:09 -0600 Subject: [PATCH 3/4] (docs): working on readme --- README.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 86 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5302fb..cda9868 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,91 @@ -# RideAware +# 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** + + ```bash + 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. + + ```bash + python3 -m venv .venv + ``` + +3. **Activate the Virtual Environment** + - On Linux/Mac: + ```bash + source .venv/bin/activate + ``` + - On Windows: + ```cmd + .venv\Scripts\activate + ``` + +4. **Install Requirements** + Install the required Python packages using pip: + ```bash + 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= +``` +- Replace `` 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**: + +```bash +docker build -t rideaware-api . +``` + +2. **Run the Container** + +```bash +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. + From 819fb0478535fe86f0fc2b15143898056540212d Mon Sep 17 00:00:00 2001 From: Blake Ridgway Date: Sun, 5 Jan 2025 17:24:00 -0600 Subject: [PATCH 4/4] (feat): Updated requirements.txt --- requirements.txt | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index a4bc47e..c25fdd0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,13 @@ Flask +<<<<<<< HEAD sqlalchemy flask_bcrypt flask_sqlalchemy -python-dotenv \ No newline at end of file +python-dotenv +======= +flask_bcrypt +flask_cors +flask_sqlalchemy +python-dotenv +werkzeug +>>>>>>> 81d9dbd ((feat): Updated requirements.txt)