How raelee1026/your-secure-files works
Project Type and Purpose
• This is a full-stack, containerized web application named “Your-Secure-Files.”
• Backend: Python (FastAPI), SQLAlchemy/Alembic migrations, JWT‐based auth, email templating (MJML).
• Frontend: Vite-powered, TypeScript/TSX SPA (React or Solid), autogenerated OpenAPI client, UI component library.
• CI/CD: GitHub Actions (lint, test, generate client, build, deploy), Docker Compose + Traefik for local/dev, staging, production environments.
File-Structure Analysis
Top-level directories:
– backend/… – source, migrations, tests, Dockerfile, scripts, alembic versions.
– frontend/… – Vite config, src/routes (file-based routing with nested layouts), src/components, autogenerated client under src/client, Playwright tests.
– .github/workflows – multiple pipelines (linting, testing, deploy‐staging, deploy‐production, generate‐client).
– docker-compose*.yml – service definitions for frontend, backend, DB, Traefik, mailcatcher, etc.
– scripts/ – wrappers for build, test, generate-client, deploy.
Key README/Docs Insights
• deployment.md & development.md explain env setup, local Compose stacks, Traefik routing, secret management.
• OpenAPI spec is emitted by the FastAPI app and consumed by generate-client.sh / GitHub Actions to produce the TypeScript client.