RosterHash/README.md
2025-10-31 18:37:29 +01:00

87 lines
2.1 KiB
Markdown

# <div align="center"><img src="rosterhash_logo.png" alt="RosterHash Logo" width="200"/></div>
<div align="center">
[![Docker Repository on Quay](https://quay.io/repository/eddiefigsystems/rosterhash/status "Docker Repository on Quay")](https://quay.io/repository/eddiefigsystems/rosterhash)
# 🏈 RosterHash
**Your Fantasy Football Command Center**
*Track all your leagues, matchups, and players in one dashboard*
</div>
## What is RosterHash?
RosterHash is your all-in-one fantasy football dashboard that connects to your Sleeper account to give you an overview of every league, every player, over a calendar view.
You can check it out here: [rosterhash.edfig.dev](https://rosterhash.edfig.dev)
### Features
- **Multi-League Dashboard** - View all your Sleeper leagues at once
- **Live Score Updates and Indicator** - See matchup score, player score per league, and Live game indicator.
- **NFL Schedule Integration** - See when your players are playing. Benched players are right-aligned and greyed out.
- **Dark/Light Theme** - Switch themes for day or night viewing
- **Mobile Responsive** - Looks great on all devices
- **Container Ready** - Easy deployment with containers for self-hosting
## Quick Start
### Option 1: Local Development
```bash
# Install dependencies
pip install -r requirements.txt
# Run the app
python app.py
# Visit http://localhost:5000
```
### Option 2: Docker
```bash
# Build and run
docker-compose up
# Or run detached
docker-compose up -d
```
## How to Use
1. **Enter your Sleeper username** on the homepage
2. **View your dashboard** - see all leagues and current week matchups
3. **Navigate weeks** - check past weeks or look ahead
4. **Theme switching** - toggle between light and dark modes
## Screenshots
# <div align="center"><img src="images/1.png" alt="First Screenshot" /></div>
# <div align="center"><img src="images/2.png" alt="First Screenshot" /></div>
</div>
## Contributing
Want to contribute?
1. Fork the repo
2. Create a feature branch
3. Make your changes
4. Submit a pull request
## License
This project is open source and available under the MIT License.
---