How nathanhumphrey/remix-app works
Project type and purpose
• This is a full-stack Remix web application starter kit (“convention over configuration”) integrating Firebase Auth and Firestore. It provides layered abstractions for authentication, session management, business controllers, database adapters, and Remix routes/components. It also includes scripts for Firebase emulators, Docker, Jest tests, and optional Cloud Functions.
File structure
Top-level layers:
• app/
• auth.server/ – Auth interfaces & implementations (File or Firebase)
• controllers.server/ – Use-case controllers implementing DBInterface
• db.server/ – Firestore DB adapter
• models/ – Business entities (e.g. User)
• util/ – Shared utilities and session abstractions (cookie/file)
• routes/ – Remix route modules (UI + loader/action code)
• entry.client.tsx & entry.server.tsx – Remix entry points
• public/ – Static assets
• functions/ – Firebase Cloud Functions (optional serverless back-end)
• emulators/, firebase-data/, firebase.json – Firebase emulator configuration & dumps
• docker-compose.yml & fb-dockerfile – Container orchestration for emulators
• tests/ – Jest unit tests for auth/models
README for additional insights
• Emphasizes separation of concerns: auth, database, controllers, models, sessions all have interfaces for “plug-n-play.”
• Uses Firebase Emulator Suite in development for both Auth and Firestore.
• Session secret, Firebase service account, API key, and emulator host variables drive configuration.
• Tailwind CSS and Vite power the front-end styling and bundling.
Detail and coverage
• Every folder’s role: routes, models, util, emulators, functions.