https://github.com/hansmissenheim/cfb-reference
📊 Self-hosted sports statistics website using NCAA game saves
https://github.com/hansmissenheim/cfb-reference
cfb fastapi ncaa sqlmodel
Last synced: 4 months ago
JSON representation
📊 Self-hosted sports statistics website using NCAA game saves
- Host: GitHub
- URL: https://github.com/hansmissenheim/cfb-reference
- Owner: hansmissenheim
- License: mit
- Created: 2024-03-25T19:33:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T03:24:06.000Z (almost 2 years ago)
- Last Synced: 2024-07-27T00:48:58.909Z (almost 2 years ago)
- Topics: cfb, fastapi, ncaa, sqlmodel
- Language: Python
- Homepage: https://cfb.hansmissenhe.im
- Size: 10.1 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
📊 Self-hosted sports statistics website using NCAA game saves.
**CFB Reference** is a personalized college football statistics database and website, created directly from your own EA Sports NCAA dynasty save files. Mirroring the experience of diving deep into sports statistics and history on similar reference sites, CFB Reference enhances the dynasty experience by offering expanded stats tracking within a modern website, built with FastAPI and HTMX.
## Demo
A live instance of CFB Reference is available at [cfb.hansmissenhe.im](https://cfb.hansmissenhe.im)
## Why?
While sports has seemingly been taken over by analytics, sports video games often lack in-depth statistical analysis seen in the real world. Many games, including the EA Sports NCAA series, have limited team and player statistics available and often remove practically all data from previous years. This leaves sports fans looking for a similar experience with their in-game world disappointed or spending many hours manually keeping track of what is available. CFB Reference addresses this by expanding the statistics tracking featured in the games with:
- Statistics available for all past years
- Tracking of players' and coaches' previous teams
- Advanced stats missing from the in-game interface
Previous tools have been created to provide players with these features but usually require manual user input or the use of extra tools to export data. CFB Reference accomplishes more while providing an easy one-click upload of the entire save file, powered by the [ncaadb](https://github.com/hansmissenheim/ncaadb) python library. The data is displayed in a familiar, yet modern interface that can be hosted and shared easily, all while never having to open the game itself.
## Preview
Below are previews of some example pages within CFB Reference. A page is created for each and every Player, School, Team, and Game and every year's history is preserved to showcase your dynasty.
Player Page
School History Page
Team Page
Upload Form
## Host locally
Docker must be installed to host CFB reference on your local machine, which can be done using [this guide](https://docs.docker.com/get-docker/). After installation, run the following commands:
```bash
docker pull hansmissenheim/cfb-reference:latest
docker run -p 8000:80 hansmissenheim/cfb-reference:latest
```
After that, an instance of CFB Reference will be accessible at [localhost:8000](http://localhost:8000).
## Contributing
### Clone the repo
```bash
git clone https://github.com/hansmissenheim/play-prediction@latest
cd play-prediction
```
### Install [Poetry](https://github.com/python-poetry/poetry) if not installed
```bash
curl -sSL https://install.python-poetry.org
```
### Install dependencies
```bash
poetry install
poetry shell
```
### And run the application
```bash
flask --app app/app.py --debug run
```
### Submit a pull request
If you would like to contribute to the project, create a fork and open a pull request on the `main` branch.