Skip to content

Commit d7bf91e

Browse files
Update documentation.
1 parent cf06b13 commit d7bf91e

2 files changed

Lines changed: 11 additions & 5 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ DDEV-based local development: PHP 8.4, MySQL 8.0, Apache.
88

99
```bash
1010
ddev start # Start containers
11-
ddev composer install # Install deps + build CSS
11+
ddev composer install # Install deps
1212
ddev exec php bin/console doctrine:migrations:migrate # Run migrations
1313
ddev launch # Open https://spread-dread.ddev.site
1414
```

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Built with Symfony 7, Tailwind CSS, and vanilla JavaScript.
88

99
- **63-game bracket** automatically wired with correct NCAA seed matchups across all six rounds
1010
- **Point spread competition** — picks are evaluated against the spread, not straight-up winners
11+
- **Turn-based picking** — players alternate picks within each round, with pick progress tracking
1112
- **ESPN integration** — pull tournament teams, spreads, and final scores directly from ESPN's API
1213
- **Live score updates** — pull scores for completed games and automatically advance winners
1314
- **Per-user authentication** — each player logs in with their own account
@@ -29,8 +30,6 @@ ddev exec php bin/console doctrine:migrations:migrate
2930
ddev launch
3031
```
3132

32-
`composer install` automatically builds the Tailwind CSS via an auto-script.
33-
3433
### Create or Update Users
3534

3635
```bash
@@ -53,6 +52,8 @@ For automatic rebuilds during development:
5352
ddev exec php bin/console tailwind:build --watch
5453
```
5554

55+
The built CSS (`var/tailwind/app.built.css`) is committed to the repo since the production server can't run the Tailwind binary. Always run `tailwind:build` locally before committing template changes.
56+
5657
### Database Changes
5758

5859
After modifying Doctrine entities:
@@ -72,14 +73,19 @@ ddev exec php bin/console cache:clear
7273

7374
1. **Create a bracket** — set the tournament year and assign two players
7475
2. **Pull teams** — fetch the 68-team field from ESPN, or enter teams manually
75-
3. **Make picks**each player taps a team per game; the opponent automatically gets the other team
76+
3. **Make picks**players take turns picking teams; the opponent automatically gets the other team
7677
4. **Pull spreads** — fetch point spreads from ESPN for each round
7778
5. **Update scores** — pull final scores from ESPN; the app evaluates picks against the spread and advances winners to the next round
7879
6. **Track the score** — a sticky scoreboard shows each player's running total
7980

81+
## Deployment
82+
83+
Deploys automatically to Dreamhost via GitHub Actions on push to `main`. The workflow SSHs into the server, pulls the latest code, installs dependencies, runs migrations, and compiles assets.
84+
8085
## Tech Stack
8186

8287
- **Backend:** PHP 8.4, Symfony 7, Doctrine ORM, MySQL 8.0
8388
- **Frontend:** Tailwind CSS (compiled via standalone CLI), Symfony AssetMapper, vanilla JavaScript
84-
- **Infrastructure:** DDEV (Apache, MySQL, PHP-FPM)
89+
- **Infrastructure:** DDEV (local), Dreamhost (production)
8590
- **External APIs:** ESPN Scoreboard & Summary APIs
91+
- **CI/CD:** GitHub Actions

0 commit comments

Comments
 (0)