Update storage docs
This commit is contained in:
3
PLAN.md
3
PLAN.md
@@ -14,6 +14,9 @@
|
||||
- Installable React PWA shell with offline-ready game prep scaffolding.
|
||||
- Docker-based local development stack.
|
||||
|
||||
## Storage Status
|
||||
- Backend media persists in the `backend-media` named Docker volume.
|
||||
|
||||
## Known Constraints
|
||||
- TeamSnap entities should not be durably mirrored on the backend.
|
||||
- Gameday lineup changes are local state in v1.
|
||||
|
||||
@@ -5,7 +5,7 @@ Walkup is a collaborative baseball walk-up song app built as a React PWA with a
|
||||
## Stack
|
||||
- Frontend: React, TypeScript, Vite, React Router, TanStack Query, `teamsnap.js`, `vite-plugin-pwa`
|
||||
- Backend: FastAPI, SQLAlchemy, Pydantic Settings, HTTPX
|
||||
- Infra: Docker Compose, Postgres, local object-style file storage
|
||||
- Infra: Docker Compose, Postgres, named Docker volume for backend media
|
||||
|
||||
## Repository Layout
|
||||
- `frontend/`: React PWA
|
||||
|
||||
@@ -22,7 +22,7 @@ Walkup is a baseball walk-up song app with a React PWA frontend and a FastAPI ba
|
||||
- `backend/` contains the FastAPI application.
|
||||
- The backend handles TeamSnap OAuth start, callback, and token refresh.
|
||||
- It manages session state, clip metadata, game assignment state, and normalized media storage.
|
||||
- Media files are stored locally in the backend storage path during development.
|
||||
- Media files are stored in the `backend-media` Docker volume, mounted at `/app/storage` during development.
|
||||
|
||||
## Data Boundaries
|
||||
|
||||
@@ -34,5 +34,5 @@ Walkup is a baseball walk-up song app with a React PWA frontend and a FastAPI ba
|
||||
|
||||
- Docker Compose is the normal development path.
|
||||
- The frontend is served separately through Vite in development.
|
||||
- The backend is run through FastAPI with local storage and Docker secrets for TeamSnap credentials.
|
||||
- The backend is run through FastAPI with Docker-managed local storage and Docker secrets for TeamSnap credentials.
|
||||
- `README.md` contains the setup steps and environment expectations.
|
||||
|
||||
Reference in New Issue
Block a user