How rolland306/tutor-connect works
Project Type & Purpose
• This is a full-stack web application (“Tutor Connect”) whose goal is to provide an online tutoring exchange platform.
• Frontend: React single-page application (SPA) built with Vite.
• Backend: Node.js + Express REST API, intended to connect to PostgreSQL (but currently reading JSON under server/config/data).
High-Level Architecture Components
a. Frontend Layer
• Built in client/src using React components and React Router.
• Bundled and served by Vite (client/vite.config.js).
• Static public assets (HTML/CSS) under client/public.
b. API Layer
• Express server (server/server.js) exposing REST endpoints under server/routes/*.js.
• Each route delegates to a controller (server/controllers/*.js) implementing business logic.
c. Data Layer
• Temporary JSON “data store” under server/config/data/*.json (chapters, classes, users).
• database.js abstracts DB access (currently reading JSON; later swap in PostgreSQL).
• dotenv.js for environment config; reset.js for seed/reset logic.
d. External Services & Dev Tools
• Environment variables via .env (handled in dotenv.js).
• Potential future PostgreSQL database instance.
Interactions & Data Flow
1. User interacts with React SPA → triggers UI events in components (e.g., search class, post comment).
2. SPA issues HTTP requests (GET/POST/PUT/DELETE) to Express API endpoints (/api/users, /api/chapters, etc.).
3. Express router picks up request → calls appropriate controller method.
4. Controller uses database.js abstraction to read/write JSON or PostgreSQL.
5. Data returned to controller → JSON response sent back to SPA.
6. SPA updates UI state based on API response.
Architectural Patterns & Design Principles
• MVC-style on server: Routes (entry point) → Controllers (business logic) → Data layer (models/JSON store).
• Component-based design on client: Reusable React components (Card, Navigation, pages).
• Clear separation of concerns:
• Presentation (React)
• API layer (Express)
• Data persistence (JSON/SQL)
Essential Details to Capture
• The client/server boundary via REST API.
• The MVC pattern on the server (Routes → Controllers → Data).
• The data persistence strategy (JSON vs. PostgreSQL).
• The build & serve process (Vite for frontend, Node for API).