asc/walkup
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update storage docs

Browse Source
This commit is contained in:
Codex
2026-04-23 11:08:36 -05:00
parent c355b3ae26
commit 226a50ea10
3 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
PLAN.md
View File

@@ -14,6 +14,9 @@
- Installable React PWA shell with offline-ready game prep scaffolding. - Installable React PWA shell with offline-ready game prep scaffolding.
- Docker-based local development stack. - Docker-based local development stack.
## Storage Status
- Backend media persists in the `backend-media` named Docker volume.
## Known Constraints ## Known Constraints
- TeamSnap entities should not be durably mirrored on the backend. - TeamSnap entities should not be durably mirrored on the backend.
- Gameday lineup changes are local state in v1. - Gameday lineup changes are local state in v1.

2
README.md
View File

@@ -5,7 +5,7 @@ Walkup is a collaborative baseball walk-up song app built as a React PWA with a
## Stack ## Stack
- Frontend: React, TypeScript, Vite, React Router, TanStack Query, `teamsnap.js`, `vite-plugin-pwa` - Frontend: React, TypeScript, Vite, React Router, TanStack Query, `teamsnap.js`, `vite-plugin-pwa`
- Backend: FastAPI, SQLAlchemy, Pydantic Settings, HTTPX - 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 ## Repository Layout
- `frontend/`: React PWA - `frontend/`: React PWA

4
docs/architecture.md
View File

@@ -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. - `backend/` contains the FastAPI application.
- The backend handles TeamSnap OAuth start, callback, and token refresh. - The backend handles TeamSnap OAuth start, callback, and token refresh.
- It manages session state, clip metadata, game assignment state, and normalized media storage. - 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 ## 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. - Docker Compose is the normal development path.
- The frontend is served separately through Vite in development. - 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. - `README.md` contains the setup steps and environment expectations.