How shobhit9742/fitbuddy works
Project Type & Purpose
• FitBuddy is a full-stack fitness-tracking web application.
• Frontend: a React/Vite single-page application (SPA) for workout logging, meal tracking, calculators, and user authentication.
• Backend: a Node.js/Express REST API backed by a JSON-server data store (db.json) providing user, meal, food, and workout endpoints.
File Structure
• Top-Level:
– /frontend: React SPA
– /backend: Node/Express API using JSON-server
– README.md, .gitignore, Photos (screenshots)
• Frontend Highlights:
– src/pages (Authentication, Dashboard, Workouts, etc.)
– src/components (sign-in/up forms, calculators, cards, navbar)
– src/api/index.js (API client)
– src/redux (userSlice, store)
– vite.config.js, public/index.html
• Backend Highlights:
– server.js (Express app entry)
– src/routes (User.js, Meal.js)
– src/controllers (User.js, foodController.js, mealController.js)
– src/models (Mongoose-style schemas, but mapped to JSON)
– src/middleware/verifyToken.js (JWT auth)
– src/db.json (data store)
README for Additional Insights
• Purpose and feature list (Workout CRUD, meal logging, calculators, admin dashboard).
• Tech stack: React, Redux, Material-UI, JSON-server, Express.
• Deployment: Frontend on Vercel, JSON-server on Render (or local).
a. Main Components
• User’s Browser (SPA client)
• React App:
– Presentation Layer (components & pages)
– State Management (Redux store)
– API Client (src/api/index.js)
• REST API Server (Express):
– Router Layer (src/routes)
– Controller Layer (src/controllers)
– Model Layer (src/models)
– Auth Middleware (verifyToken)
• Data Store: JSON-server (db.json)
• External Hosting Services: Vercel (frontend), Render or local JSON-server (backend)
b. Relationships & Interactions
1. User ⇒ Browser ⇒ React App UI
2. React App dispatches Redux actions → API Client issues HTTP requests
3. Express receives requests → verifyToken (for protected routes) → routes → controllers → model layer → JSON-server reads/writes db.json
4. JSON-server response bubbles back through controllers → Express → JSON payload → React API client → Redux store → UI update
c. Architectural Patterns & Design Principles
• Frontend: Component-based UI, unidirectional data flow (Redux), separation of concerns (pages vs. shared components).
• Backend: MVC-inspired layering (Routes → Controllers → Models), middleware for cross-cutting concerns (authentication).
• RESTful API design, token-based stateless auth (JWT).
d. Key Technologies & Frameworks
• React.js, Vite, Redux, Material-UI (frontend)
• Node.js, Express, JSON-server, JWT (backend)