How kelvkvs/diario-de-viagem works
Project type and purpose
• This is a full-stack web application (“Diário de Viagem – Blog”) that lets users register, log in, create trips and posts, view other users’ trips, and manage their own content.
• The frontend is a React/Vite SPA. The backend is a Node.js/Express service following an MVC pattern.
File structure
• Top level: two primary directories, backend/ and frontend/, plus root-level package.json scripts orchestrating both.
• backend/
• src/app.js: Express app entry point
• controllers/: route handlers for auth, posts, trips, users
• models/: data schemas (likely Mongoose models for MongoDB)
• routes/: defines API endpoints mounted on Express
• middleware/: authentication guard (JWT, sessions, etc.)
• frontend/
• src/main.jsx & index.html: React entry point
• assets/components/: reusable UI components (Sidebar, Navbar, PostCard)
• pages/: route-level components (login, register, createTrip, newPost, userProfile, home)
• vite.config.js & eslint.config.js: build and lint configurations
Key insights from README
• Development uses two processes concurrently:
• cd backend && npm install → Express service
• cd frontend && npm install → React SPA
• npm run start:dev launches both via a root-level script (likely using concurrently or similar tool).
a. Main components
• Client (Browser): React SPA
• API Gateway / Server: Node.js/Express backend
• Database: MongoDB (inferred from models folder)
• External Auth (JWT): middleware issuing and verifying tokens
• Static Assets: hosted by Vite dev server (in production could be served via CDN)
b. Relationships & interactions
1. User → Browser: user interacts with React UI.
2. Browser → Express API: HTTP(S) calls to endpoints (e.g., POST /auth/login, GET /posts).
3. Express Controllers ↔ Models: controllers process requests, call models for CRUD in MongoDB.
4. Middleware: authMiddleware intercepts protected routes → verifies JWT → attaches user context.
5. Database: Express connects to MongoDB cluster/instance for persistent storage.
c. Architectural patterns & design principles
• MVC: models for data, controllers for logic, routes for URL mapping.
• Component-based UI: React functional components and pages.
• Separation of concerns: frontend and backend are decoupled; communicate over a RESTful API.
• Stateless authentication: JWT tokens in headers/cookies.
d. Technologies & frameworks
• Frontend: React, Vite, JSX, CSS modules
• Backend: Node.js, Express, Mongoose (inferred), JSON Web Tokens
• Build/Dev: npm scripts, concurrently (or similar)
Detail
• Break backend into sub-components: routes, controllers, models, middleware.
• On the frontend, group pages vs. shared components vs. assets/styles.
• Authentication flow: login → receive JWT → attach to subsequent requests → middleware validation.
• If hosting or deployment scripts exist, show them as external processes (CI/CD, Docker, etc.).