Development Setup Instructions
This walkthrough is a how-to for setting up your system to develop and run locally the BGG-Companion app.
This project uses Python in the backend using Flask as a Python web framework. We use Poetry as the dependency management and packaging tool for Python. There's documentation to follow here or you could install these dotfiles here.
Once Poetry is on your machine and you've cloned this repository you can simply preform a poetry install in the root directory of the repo to install all project dependencies.
To run the application locally you can run poetry run flask run and boot-up a local dev server.
Then open the local server IP in your browser plus the endpoint you want to hit. At the time of writing this doc, /home is the primary endpoint. You can also see app.py for all Flask endpoints.
