Clone and Start Locally¶
This guide is for contributors and self-hosters who want to run theTowerStats on a local machine.
Prerequisites¶
- Python (project version)
- SQLite (default dev database)
- A local virtual environment (recommended)
Steps¶
- Clone the repository from GitHub.
- Create and activate a virtual environment.
- Install dependencies with
requirements.txt(andrequirements-dev.txtfor linting/testing). - Run migrations with
python manage.py migrate. - Start the dev server with
python manage.py runserver. - Open the app at
http://127.0.0.1:8000/.
Notes¶
- Demo data is available after you sign in and enable demo mode from the landing page.
- Use
pytest,ruff, andmypyfor the full validation suite before opening a PR.