Your AI Boxing Coach! Get the workout you deserve!
Explore the docs »

View Demo · Report Bug · Request Feature

• React
• Python
• Flask
• SQLAlchemy
• Redux

To get a local copy up and running follow these simple steps.

1. Clone the repo

   git clone https://github.com/RoodeAwakening/Boxit.git

2. Install NPM packages

   pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt

3. Create a .env file based on the example with proper settings for your development environment

4. Setup your PostgreSQL user, password and database and make sure it matches your .env file

5. Get into your pipenv, migrate your database, seed your database, and run your flask app

   pipenv shell

   flask db upgrade

   flask seed all

   flask run

6. Start the front end and back end

    frontend - 
    cd react-app npm start
    backend - 
    flask run

IMPORTANT! If you add any python dependencies to your pipfiles, you'll need to regenerate your requirements.txt before deployment. You can do this by running:

pipenv lock -r > requirements.txt

ALSO IMPORTANT! psycopg2-binary MUST remain a dev dependency because you can't install it on apline-linux. There is a layer in the Dockerfile that will install psycopg2 (not binary) for us.

This website was designed as an alternative to going to a boxing gym. Giving you a personalized workout in the comfort of your own home!

For more examples, please refer to the Documentation

See the open issues for a list of proposed features (and known issues).

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the MIT License. See LICENSE for more information.

Derek Roode - [email protected]

Project Link: https://github.com/RoodeAwakening/Boxit