MotorSignal-App/backend/motorsignal_api/README.md

27 lines
1.1 KiB
Markdown

# MotorSignal API
Local recovery of the deployed FastAPI application and Alembic baseline.
## Provenance
- Source copied from `/opt/motorsignal/current` on the production VPS on 2026-09-08.
- Current release resolved to `/opt/motorsignal/releases/20260906-01`.
- Production environment files, credentials, virtualenv files, and database data were not copied.
- `requirements.lock` was reconstructed from the running production virtualenv with `pip freeze`; parity against a fresh production freeze passed.
## Current scope
The recovered API contains health/readiness checks, registration, login, refresh,
logout, and current-user lookup. The recovered Alembic history contains one
revision creating `users` and `sessions`.
Email verification, password reset, session management endpoints, roles/RBAC,
audit events, vehicles, rides, telemetry, entitlements, and admin endpoints are
not present in this baseline.
## Local safety
Do not point local commands at production. Use a development database and an
explicit local environment file. Never commit secrets or production database
credentials.