# tpenha05/regula-front architecture

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

- Interactive diagram: https://gitdiagram.com/tpenha05/regula-front
- Repository: https://github.com/tpenha05/regula-front

## Overview

##### Project Type and Purpose
- This is a front-end single-page application (SPA) built with React and TypeScript, bundled by Vite and deployed (via Vercel).
- It provides a public marketing site, user-facing app, and admin console, communicating with a separate backend via RESTful endpoints (e.g. auth, user, contact, profile, “sinister”).

##### File Structure Analysis
- Top level
- index.html, package.json, vite.config.* → Vite-powered React app
- public/landing_page & public/about → static assets for marketing pages
- src/
– components/ui/… → design-system primitives (buttons, dialogs, menus, toasts, etc.)
– lib/utils.ts, config/config.ts → shared utilities & environment configuration
– main.tsx, App.tsx, router.tsx → application entry, React Router setup
– pages/ → feature modules organized by audience (public, user, admin)
· public/auth & public/main → login, password reset, landing, about, contact
· user/auth, user/dashboard → protected user flows (logout, token check, dashboard sub-routes)
· admin/auth, admin/dashboard → admin-only auth and dashboard
– each “api” folder under pages invokes external HTTP endpoints (login, logout, CheckToken, contact, users, profile, sinister).
- Config files: tsconfig*, eslint.config.js, vercel.json

##### Component Relationships & Interactions
- Browser loads index.html → main.tsx → App.tsx
- Router directs to Public, User, or Admin feature modules
- Pages import design-system UI components to render forms/pages
- On user action (e.g. login, fetch dashboard data), page calls its local “api” module → issues HTTP request to corresponding backend service
- Auth tokens persisted (cookie or localStorage) and sent with requests
- Responses update React state, drive UI
- Vercel serves static assets, rewrites API paths (if any serverless functions exist)

##### Architectural Patterns & Principles
- Modular feature structure: pages grouped by domain/role
- Design-system driven UI for consistent look & feel
- Clear separation: Presentation (UI components) vs. Routing (router.tsx) vs. Business logic (api modules)
- Thin client: relies on backend for data, only handles rendering & state management
- Environment-based configuration via src/config/config.ts

##### Technologies & Frameworks
- React (tsx), React Router
- TypeScript, Vite (bundler & dev server)
- CSS (index.css), utility classes?
- ESLint for linting
- Vercel for deployment

## Diagram (Mermaid)

```mermaid
flowchart TB
  subgraph "Browser / Client"
    direction TB
    UI["UI Library (src/components/ui)"]:::ui
    Entry["Entry Point (src/main.tsx)"]:::entry
    App["App Component (src/App.tsx)"]:::entry
    Router["Router (src/router.tsx)"]:::router
    Utils["Shared Utils (src/lib/utils.ts)"]:::util
    Config["Env Config (src/config/config.ts)"]:::util
  end

  subgraph "Pages"
    direction TB

    subgraph "Public Module"
      direction TB
      PubRoutes["Routes (src/pages/public/routes.tsx)"]:::router
      AuthUI["Auth UI (auth.tsx)"]:::page
      LoginUser["User Login API"]:::api
      LoginAdmin["Admin Login API"]:::api
      ReqReset["Request Reset API"]:::api
      DoReset["Perform Reset API"]:::api
      Register["User Register API"]:::api
      MainPage["Main UI (public.tsx)"]:::page
      ContactPub["Contact API"]:::api
      About["About Page"]:::page
      Home["Home Page"]:::page
    end

    subgraph "User Module"
      direction TB
      UserRoutes["Routes (src/pages/user/routes.tsx)"]:::router
      LogoutUser["Logout API"]:::api
      CheckTokenUser["CheckToken API"]:::api
      DashUser["Dashboard UI"]:::page
      HeaderUser["Header API"]:::api
      SinisterUser["Sinister API"]:::api
      ProfileUser["Profile API"]:::api
    end

    subgraph "Admin Module"
      direction TB
      AdminRoutes["Routes (src/pages/admin/routes.tsx)"]:::router
      LogoutAdmin["Logout API"]:::api
      CheckTokenAdmin["CheckToken API"]:::api
      DashAdmin["Dashboard UI"]:::page
      HeaderAdmin["Header API"]:::api
      ContactAdmin["Contact API"]:::api
      SinisterAdmin["Sinister API"]:::api
      ProfileAdmin["Profile API"]:::api
      UsersAdmin["Users Management API"]:::api
    end
  end

  subgraph "Backend Services"
    direction TB
    AuthService[(Auth Service)]:::service
    UserService[(User Service)]:::service
    AdminService[(Admin Service)]:::service
    ContactService[(Contact Service)]:::service
  end

  subgraph "Build & Deploy"
    direction TB
    Vite["Vite (vite.config.*)"]:::build
    Vercel["Vercel (vercel.json)"]:::deploy
  end

  %% Client Flow
  UI --> Entry
  Entry --> App
  App --> Router
  Router --> PubRoutes
  Router --> UserRoutes
  Router --> AdminRoutes

  PubRoutes --> AuthUI
  PubRoutes --> MainPage

  AuthUI --> LoginUser
  AuthUI --> LoginAdmin
  AuthUI --> ReqReset
  AuthUI --> DoReset
  AuthUI --> Register

  MainPage --> ContactPub
  MainPage --> About
  MainPage --> Home

  UserRoutes --> LogoutUser
  UserRoutes --> CheckTokenUser
  UserRoutes --> DashUser
  DashUser --> HeaderUser
  DashUser --> SinisterUser
  DashUser --> ProfileUser

  AdminRoutes --> LogoutAdmin
  AdminRoutes --> CheckTokenAdmin
  AdminRoutes --> DashAdmin
  DashAdmin --> HeaderAdmin
  DashAdmin --> ContactAdmin
  DashAdmin --> SinisterAdmin
  DashAdmin --> ProfileAdmin
  DashAdmin --> UsersAdmin

  %% API to Services
  LoginUser --> AuthService
  LoginAdmin --> AuthService
  ReqReset --> AuthService
  DoReset --> AuthService
  Register --> UserService
  LogoutUser --> AuthService
  CheckTokenUser --> AuthService
  LogoutAdmin --> AuthService
  CheckTokenAdmin --> AuthService
  ProfileUser --> UserService
  ProfileAdmin --> UserService
  UsersAdmin --> AdminService
  SinisterUser --> AdminService
  SinisterAdmin --> AdminService
  ContactPub --> ContactService
  ContactAdmin --> ContactService

  %% Build & Deploy Flow
  Vite --> Vercel

  %% Cross-cutting Utils & Config
  Utils --> UI
  Utils --> App
  Utils --> Router
  Config --> App
  Config --> Router

  %% Click Events
  click UI "https://github.com/tpenha05/regula-front/tree/main/regula-ai/src/components/ui"
  click Entry "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/main.tsx"
  click App "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/App.tsx"
  click Router "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/router.tsx"
  click Utils "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/lib/utils.ts"
  click Config "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/config/config.ts"
  click PubRoutes "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/routes.tsx"
  click AuthUI "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/auth/auth.tsx"
  click LoginUser "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/auth/nested/userLogin/api/Login.ts"
  click LoginAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/auth/nested/adminLogin/api/login.ts"
  click ReqReset "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/auth/nested/resetPass/api/RequestPasswordReset.ts"
  click DoReset "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/auth/nested/resetPass/api/PasswordReset.ts"
  click Register "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/auth/nested/userRegister/api/register.ts"
  click MainPage "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/main/public.tsx"
  click ContactPub "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/main/nested/contact/api/contact.ts"
  click About "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/main/nested/about/about.tsx"
  click Home "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/public/main/nested/home/home.tsx"
  click UserRoutes "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/user/routes.tsx"
  click LogoutUser "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/user/auth/logout/api/logout.ts"
  click CheckTokenUser "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/user/auth/token/api/CheckToken.ts"
  click DashUser "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/user/dashboard/dashboard.tsx"
  click HeaderUser "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/user/dashboard/components/api/header.ts"
  click SinisterUser "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/user/dashboard/nested/home/api/sinister.ts"
  click ProfileUser "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/user/dashboard/nested/profile/api/profile.ts"
  click AdminRoutes "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/routes.tsx"
  click LogoutAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/auth/logout/api/logout.ts"
  click CheckTokenAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/auth/token/api/CheckToken.ts"
  click DashAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/dashboard/dashboard.tsx"
  click HeaderAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/dashboard/components/api/header.ts"
  click ContactAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/dashboard/nested/contact/api/contact.ts"
  click SinisterAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/dashboard/nested/home/api/sinister.ts"
  click ProfileAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/dashboard/nested/profile/api/profile.ts"
  click UsersAdmin "https://github.com/tpenha05/regula-front/blob/main/regula-ai/src/pages/admin/dashboard/nested/users/api/users.ts"
  click Vite "https://github.com/tpenha05/regula-front/blob/main/regula-ai/vite.config.ts"
  click Vercel "https://github.com/tpenha05/regula-front/blob/main/regula-ai/vercel.json"

  %% Styles
  classDef ui fill:#D0E8FF,stroke:#0366D6,color:#0366D6
  classDef entry fill:#E8F5D7,stroke:#0F5132,color:#0F5132
  classDef router fill:#E2FFE2,stroke:#198754,color:#198754
  classDef util fill:#FFF3CD,stroke:#856404,color:#856404
  classDef page fill:#FFF0F6,stroke:#C11574,color:#C11574
  classDef api fill:#F3E5F5,stroke:#6F42C1,color:#6F42C1
  classDef service fill:#FFE8CC,stroke:#D39E00,color:#D39E00
  classDef build fill:#E9ECEF,stroke:#6C757D,color:#6C757D
  classDef deploy fill:#E2E3E5,stroke:#ADB5BD,color:#495057
```
