Table of Contents
This app serves as a tool to quickly calculate percentages and warmups for your 5/3/1 workout, based off of your training max.
To get a local copy up and running follow these steps.
- python 3.9+
- npm
npm install npm@latest -g
- yarn (optional)
npm install yarn@latest -g
- docker (optional)
- docker-compose (optional)
- Clone the repo:
git clone https://github.com/ceruleanskis/531Calculator.git
- Navigate to the
uidirectory and install the NPM packages:npm install
- Or, if using Yarn:
yarn install
- Or, if using Yarn:
- Navigate to the
serverdirectory and install the Python packages:python -m venv venv source venv/bin/activate pip install -e .
- Navigate to the
uidirectory. - Serve the React app:
yarn start
- Navigate to the
serverdirectory. - Serve the Flask app:
FLASK_APP=fivethreeonecalc FLASK_ENV=development flask run
- You should see the app at http://localhost:3000.
docker-compose -f docker-compose.dev.yml up
You should see the app at http://localhost:8080.
To run the frontend tests:
Navigate to the ui directory and run:
yarn run test
To run the backend tests:
Navigate to the server directory and run:
pytest
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the GPL 3 License. See LICENSE.txt for more information.