# kelvkvs/diario-de-viagem architecture

> Architecture diagram of the GitHub repository kelvkvs/diario-de-viagem, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kelvkvs/diario-de-viagem
- Repository: https://github.com/kelvkvs/diario-de-viagem

## Overview

##### 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.).

## Diagram (Mermaid)

```mermaid
graph TB
  %% Frontend Layer
  subgraph "Frontend Layer"
    direction TB
    Browser["User Browser"]:::external
    ReactSPA["React SPA"]:::frontend
    subgraph "UI Components"
      direction TB
      Sidebar["Sidebar"]:::frontend
      Navbar["Navbar"]:::frontend
      PostCard["PostCard"]:::frontend
    end
    subgraph "Pages"
      direction TB
      Home["Home Page"]:::frontend
      Login["Login Page"]:::frontend
      Register["Register Page"]:::frontend
      CreateTrip["CreateTrip Page"]:::frontend
      NewPost["NewPost Page"]:::frontend
      UserProfile["UserProfile Page"]:::frontend
    end
    subgraph "Config & Assets"
      direction TB
      ViteConfig["vite.config.js"]:::infra
      ESLintConfig["eslint.config.js"]:::infra
      PublicImages["Public Images"]:::infra
    end
  end

  %% Backend Layer
  subgraph "Backend Layer"
    direction TB
    ExpressApp["Express App (app.js)"]:::backend
    AuthMiddleware["Auth Middleware"]:::middleware
    subgraph "Routes"
      direction TB
      PostRoutes["Post Routes"]:::backend
      TripRoutes["Trip Routes"]:::backend
      UserRoutes["User Routes"]:::backend
    end
    subgraph "Controllers"
      direction TB
      AuthController["Auth Controller"]:::backend
      PostController["Post Controller"]:::backend
      TripController["Trip Controller"]:::backend
      UserController["User Controller"]:::backend
    end
    subgraph "Models"
      direction TB
      PostModel["Post Model"]:::datastore
      TripModel["Trip Model"]:::datastore
      UserModel["User Model"]:::datastore
    end
  end

  %% Database Layer
  subgraph "Database Layer"
    direction TB
    MongoDB["MongoDB"]:::datastore
  end

  %% Orchestration
  RootScript["npm run start:dev"]:::infra

  %% Connections
  Browser --> ReactSPA
  ReactSPA -->|HTTP Requests| ExpressApp
  ExpressApp --> AuthMiddleware
  AuthMiddleware --> PostRoutes
  AuthMiddleware --> TripRoutes
  AuthMiddleware --> UserRoutes
  PostRoutes --> PostController
  TripRoutes --> TripController
  UserRoutes --> UserController
  AuthController --> UserModel
  PostController --> PostModel
  TripController --> TripModel
  UserController --> UserModel
  PostModel --> MongoDB
  TripModel --> MongoDB
  UserModel --> MongoDB
  ExpressApp --> ReactSPA
  RootScript --> ExpressApp
  RootScript --> ReactSPA
  ReactSPA --> Sidebar
  ReactSPA --> Navbar
  ReactSPA --> PostCard
  ReactSPA --> Home
  ReactSPA --> Login
  ReactSPA --> Register
  ReactSPA --> CreateTrip
  ReactSPA --> NewPost
  ReactSPA --> UserProfile
  ReactSPA --> ViteConfig
  ReactSPA --> ESLintConfig
  ReactSPA --> PublicImages

  %% Click Events
  click ReactSPA "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/App.jsx"
  click ReactSPA "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/main.jsx"
  click Sidebar "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/assets/components/Sidebar.jsx"
  click Navbar "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/assets/components/navbar.jsx"
  click PostCard "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/assets/components/postcard.jsx"
  click Home "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/pages/index.jsx"
  click Login "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/pages/login.jsx"
  click Register "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/pages/register.jsx"
  click CreateTrip "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/pages/createtrip.jsx"
  click CreateTrip "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/assets/style/CreateTrip.css"
  click NewPost "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/pages/newpost.jsx"
  click NewPost "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/pages/newpost.css"
  click UserProfile "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/src/pages/userprofile.jsx"
  click ViteConfig "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/vite.config.js"
  click ESLintConfig "https://github.com/kelvkvs/diario-de-viagem/blob/main/frontend/eslint.config.js"
  click PublicImages "https://github.com/kelvkvs/diario-de-viagem/tree/main/frontend/public/images"
  click ExpressApp "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/app.js"
  click AuthMiddleware "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/middleware/authMiddleware.js"
  click PostRoutes "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/routes/postRoutes.js"
  click TripRoutes "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/routes/tripRoutes.js"
  click UserRoutes "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/routes/userRoutes.js"
  click AuthController "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/controllers/authController.js"
  click PostController "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/controllers/postController.js"
  click TripController "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/controllers/tripController.js"
  click UserController "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/controllers/userController.js"
  click PostModel "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/models/posts.js"
  click TripModel "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/models/trip.js"
  click UserModel "https://github.com/kelvkvs/diario-de-viagem/blob/main/backend/src/models/user.js"
  click RootScript "https://github.com/kelvkvs/diario-de-viagem/blob/main/package.json"

  %% Styles
  classDef frontend fill:#E0F7FA,stroke:#006064
  classDef backend fill:#E8F5E9,stroke:#2E7D32
  classDef datastore fill:#FFF3E0,stroke:#EF6C00
  classDef middleware fill:#FFF9C4,stroke:#F9A825
  classDef infra fill:#ECEFF1,stroke:#546E7A
  classDef external fill:#CFD8DC,stroke:#455A64
```
