82 lines
2.9 KiB
Markdown
82 lines
2.9 KiB
Markdown
# Tonehaus — Music Ratings (Symfony 7)
|
||
|
||
Discover albums via Last.fm, write and manage reviews, and administer your site. Built with Symfony 7, Twig, Doctrine, and Bootstrap.
|
||
|
||
## Quick start (Docker Compose)
|
||
|
||
1) Start the stack
|
||
|
||
```bash
|
||
docker compose up -d --build
|
||
```
|
||
|
||
2) Open the app
|
||
|
||
- App URL: `http://localhost:8085`
|
||
- Health: `http://localhost:8085/healthz`
|
||
|
||
3) Create your first admin
|
||
|
||
- Sign Up through Tonehaus
|
||
|
||
```bash
|
||
docker compose exec tonehaus php bin/console app:promote-admin you@example.com
|
||
```
|
||
|
||
4) Configure Last.fm
|
||
|
||
- Go to `http://localhost:8085/admin/settings` and enter your Last.fm API key, or
|
||
- Set env var in `.env`: `LASTFM_API_KEY`
|
||
|
||
5) (Optional) Seed demo data
|
||
|
||
```bash
|
||
docker compose exec tonehaus php bin/console app:seed-demo-users --count=50
|
||
docker compose exec tonehaus php bin/console app:seed-demo-albums --count=40 --attach-users
|
||
docker compose exec tonehaus php bin/console app:seed-demo-reviews --cover-percent=70 --max-per-album=8
|
||
```
|
||
|
||
Notes:
|
||
- The packaged image uses SQLite by default and runs Doctrine migrations on start (idempotent).
|
||
- To switch to Postgres, set `DATABASE_DRIVER=postgres` and provide `DATABASE_URL`.
|
||
|
||
## Features
|
||
|
||
- Last.fm-backed album search with advanced filters (album, artist, year range) and per‑album aggregates (avg/count)
|
||
- REST API under `/api/v1` for albums/reviews with JSON responses and proper HTTP verbs
|
||
- JWT authentication for protected API endpoints (`/api/v1/auth/login`) via LexikJWTAuthenticationBundle
|
||
- REST response handling via FOSRestBundle
|
||
- Automatic OpenAPI documentation at `/api/docs` and `/api/v1/docs` (JSON at `/api/docs.json` and `/api/v1/docs.json`)
|
||
- Album page with details, tracklist, reviews list, and inline new review (logged-in)
|
||
- Auth modal (Login/Sign up) with remember‑me; no separate pages
|
||
- Role-based access: authors manage their own reviews; moderators/admins can moderate content
|
||
- Admin Site Settings: manage Last.fm API key and public registration toggle
|
||
- User Dashboard: profile updates and password change
|
||
- Light/Dark theme toggle (cookie-backed)
|
||
|
||
## Documentation
|
||
|
||
- Setup and configuration: `docs/setup.md`
|
||
- Feature overview: `docs/features.md`
|
||
- Authentication and users: `docs/auth-and-users.md`
|
||
- Last.fm integration: `docs/lastfm-integration.md`
|
||
- Reviews and albums: `docs/reviews-and-albums.md`
|
||
- Admin & site settings: `docs/admin-and-settings.md`
|
||
- Troubleshooting: `docs/troubleshooting.md`
|
||
- Architecture: `docs/architecture.md`
|
||
- Deployment: `docs/deployment.md`
|
||
|
||
## Environment overview
|
||
|
||
- `APP_ENV` (dev|prod), `APP_SECRET` (required)
|
||
- `LASTFM_API_KEY`
|
||
- `JWT_PASSPHRASE` (used for JWT private key encryption)
|
||
- `APP_ALLOW_REGISTRATION` (1|0) — DB setting can be overridden by env
|
||
- `DATABASE_DRIVER` (sqlite|postgres), `DATABASE_URL` (when using Postgres)
|
||
- `DATABASE_SQLITE_PATH` (optional, defaults to `var/data/database.sqlite`)
|
||
- `RUN_MIGRATIONS_ON_START` (1|0, defaults to 1)
|
||
|
||
## License
|
||
|
||
MIT
|