# mantu0019/3_soen architecture

> Architecture diagram of the GitHub repository mantu0019/3_soen, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mantu0019/3_soen
- Repository: https://github.com/mantu0019/3_soen

## Overview

This is a full-stack project collaboration application: users register or log in, enter a protected dashboard, create and view projects, and manage project collaborators. The frontend routes requests through feature state/actions and API services to the Express backend, whose routes validate and authenticate requests before controllers update or query MongoDB. Authentication also uses Redis for logout-token blacklisting. The graph preserves the documented-in-source auth and project branches; some frontend-to-backend HTTP wiring and database details were not shown, so those links are marked unverified.

Main entry points: [`backend/src/routes/auth.routes.js`](https://github.com/mantu0019/3_soen/blob/main/backend/src/routes/auth.routes.js) (Auth routes), [`backend/src/routes/project.routes.js`](https://github.com/mantu0019/3_soen/blob/main/backend/src/routes/project.routes.js) (Project routes), [`frontend/src/app/AppRoutes.jsx`](https://github.com/mantu0019/3_soen/blob/main/frontend/src/app/AppRoutes.jsx) (Client routes), [`frontend/src/app/api.js`](https://github.com/mantu0019/3_soen/blob/main/frontend/src/app/api.js) (Shared HTTP client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web client"]
  node_routes["Client routes<br/>[AppRoutes.jsx]"]
  node_home["Dashboard<br/>[Home.jsx]"]
  node_api["Shared HTTP client<br/>[api.js]"]
end

subgraph group_auth["Authentication"]
  node_authpages["Login and register"]
  node_authhook["Auth hook<br/>[useAuth.jsx]"]
  node_authactions["Auth actions<br/>[authAction.js]"]
  node_authapi["Auth API client<br/>[api.js]"]
  node_authstate["Auth state<br/>[authSlice.jsx]"]
end

subgraph group_projects["Project collaboration"]
  node_projectpages["Project views"]
  node_projecthook["Project hook<br/>[useProject.jsx]"]
  node_projectactions["Project actions<br/>[projectAction.js]"]
  node_projectapi["Project API client<br/>[api.js]"]
  node_projectstate["Project state<br/>[projectSlice.jsx]"]
end

subgraph group_server["API server"]
  node_authroutes["Auth routes<br/>[auth.routes.js]"]
  node_authcontroller["User controller<br/>[user.controller.js]"]
  node_authmiddleware["Token middleware<br/>[auth.middleware.js]"]
  node_validation["Auth validation<br/>[user.validation.js]"]
  node_projectroutes["Project routes<br/>[project.routes.js]"]
  node_projectvalidation["Project validation"]
  node_projectcontroller["Project controller"]
  node_app["Express application<br/>[app.js]"]
end

subgraph group_persistence["Persistence"]
  node_userstore[("User records<br/>[user.model.js]")]
  node_projectstore[("Project records<br/>[project.model.js]")]
  node_redisclient["Redis client<br/>[redies.services.js]"]
end

node_user(("User"))
node_redis[("Redis")]
node_mongo[("MongoDB")]

node_user -->|"uses"| node_routes
node_routes -->|"routes to"| node_authpages
node_routes -->|"routes to"| node_home
node_routes -->|"routes to"| node_projectpages
node_authpages -->|"dispatches via"| node_authhook
node_authhook -->|"dispatches"| node_authactions
node_authactions -->|"calls"| node_authapi
node_authapi -->|"uses"| node_api
node_authstate -->|"handles"| node_authactions
node_projectpages -->|"uses"| node_projecthook
node_projecthook -->|"dispatches"| node_projectactions
node_projectactions -->|"calls"| node_projectapi
node_projectapi -->|"uses"| node_api
node_projectstate -->|"handles"| node_projectactions
node_api -.->|"HTTP requests"| node_authroutes
node_api -.->|"HTTP requests"| node_projectroutes
node_app -->|"mounts"| node_authroutes
node_app -->|"mounts"| node_projectroutes
node_authroutes -->|"validates"| node_validation
node_authroutes -->|"authenticates"| node_authmiddleware
node_authroutes -->|"dispatches"| node_authcontroller
node_authcontroller -->|"reads and writes"| node_userstore
node_authcontroller -->|"blacklists tokens"| node_redisclient
node_authmiddleware -->|"checks blacklist"| node_redisclient
node_authmiddleware -->|"loads user"| node_userstore
node_projectroutes -->|"validates"| node_projectvalidation
node_projectroutes -->|"authenticates"| node_authmiddleware
node_projectroutes -->|"dispatches"| node_projectcontroller
node_projectcontroller -->|"reads and writes"| node_projectstore
node_projectcontroller -->|"loads users"| node_userstore
node_redisclient -.->|"connects"| node_redis
node_userstore -.->|"persists records"| node_mongo
node_projectstore -.->|"persists records"| node_mongo

click node_routes "https://github.com/mantu0019/3_soen/blob/main/frontend/src/app/AppRoutes.jsx"
click node_home "https://github.com/mantu0019/3_soen/blob/main/frontend/src/components/Home.jsx"
click node_authpages "https://github.com/mantu0019/3_soen/tree/main/frontend/src/features/auth/pages"
click node_authhook "https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/auth/hooks/useAuth.jsx"
click node_authactions "https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/auth/state/authAction.js"
click node_authapi "https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/auth/services/api.js"
click node_authstate "https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/auth/state/authSlice.jsx"
click node_projectpages "https://github.com/mantu0019/3_soen/tree/main/frontend/src/features/project/pages"
click node_projecthook "https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/project/hook/useProject.jsx"
click node_projectactions "https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/project/state/projectAction.js"
click node_projectapi "https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/project/services/api.js"
click node_projectstate "https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/project/state/projectSlice.jsx"
click node_api "https://github.com/mantu0019/3_soen/blob/main/frontend/src/app/api.js"
click node_authroutes "https://github.com/mantu0019/3_soen/blob/main/backend/src/routes/auth.routes.js"
click node_authcontroller "https://github.com/mantu0019/3_soen/blob/main/backend/src/controller/user.controller.js"
click node_authmiddleware "https://github.com/mantu0019/3_soen/blob/main/backend/src/middleware/auth.middleware.js"
click node_validation "https://github.com/mantu0019/3_soen/blob/main/backend/src/services/user.validation.js"
click node_projectroutes "https://github.com/mantu0019/3_soen/blob/main/backend/src/routes/project.routes.js"
click node_projectvalidation "https://github.com/mantu0019/3_soen/blob/main/backend/src/services/project.services.js"
click node_projectcontroller "https://github.com/mantu0019/3_soen/blob/main/backend/src/controller/project.controller.js"
click node_app "https://github.com/mantu0019/3_soen/blob/main/backend/src/app.js"
click node_userstore "https://github.com/mantu0019/3_soen/blob/main/backend/src/models/user.model.js"
click node_projectstore "https://github.com/mantu0019/3_soen/blob/main/backend/src/models/project.model.js"
click node_redisclient "https://github.com/mantu0019/3_soen/blob/main/backend/src/services/redies.services.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_routes,node_home,node_api,node_user toneBlue
class node_authpages,node_authhook,node_authactions,node_authapi,node_authstate,node_redis,node_mongo toneAmber
class node_projectpages,node_projecthook,node_projectactions,node_projectapi,node_projectstate toneMint
class node_authroutes,node_authcontroller,node_authmiddleware,node_validation,node_projectroutes,node_projectvalidation,node_projectcontroller,node_app toneRose
class node_userstore,node_projectstore,node_redisclient toneIndigo
```

## Components

### Web client

- [Client routes](https://github.com/mantu0019/3_soen/blob/main/frontend/src/app/AppRoutes.jsx): `frontend/src/app/AppRoutes.jsx`
- [Dashboard](https://github.com/mantu0019/3_soen/blob/main/frontend/src/components/Home.jsx): `frontend/src/components/Home.jsx`
- [Shared HTTP client](https://github.com/mantu0019/3_soen/blob/main/frontend/src/app/api.js): `frontend/src/app/api.js`

### Authentication

- [Login and register](https://github.com/mantu0019/3_soen/tree/main/frontend/src/features/auth/pages): `frontend/src/features/auth/pages`
- [Auth hook](https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/auth/hooks/useAuth.jsx): `frontend/src/features/auth/hooks/useAuth.jsx`
- [Auth actions](https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/auth/state/authAction.js): `frontend/src/features/auth/state/authAction.js`
- [Auth API client](https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/auth/services/api.js): `frontend/src/features/auth/services/api.js`
- [Auth state](https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/auth/state/authSlice.jsx): `frontend/src/features/auth/state/authSlice.jsx`

### Project collaboration

- [Project views](https://github.com/mantu0019/3_soen/tree/main/frontend/src/features/project/pages): `frontend/src/features/project/pages`
- [Project hook](https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/project/hook/useProject.jsx): `frontend/src/features/project/hook/useProject.jsx`
- [Project actions](https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/project/state/projectAction.js): `frontend/src/features/project/state/projectAction.js`
- [Project API client](https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/project/services/api.js): `frontend/src/features/project/services/api.js`
- [Project state](https://github.com/mantu0019/3_soen/blob/main/frontend/src/features/project/state/projectSlice.jsx): `frontend/src/features/project/state/projectSlice.jsx`

### API server

- [Auth routes](https://github.com/mantu0019/3_soen/blob/main/backend/src/routes/auth.routes.js): `backend/src/routes/auth.routes.js`
- [User controller](https://github.com/mantu0019/3_soen/blob/main/backend/src/controller/user.controller.js): `backend/src/controller/user.controller.js`
- [Token middleware](https://github.com/mantu0019/3_soen/blob/main/backend/src/middleware/auth.middleware.js): `backend/src/middleware/auth.middleware.js`
- [Auth validation](https://github.com/mantu0019/3_soen/blob/main/backend/src/services/user.validation.js): `backend/src/services/user.validation.js`
- [Project routes](https://github.com/mantu0019/3_soen/blob/main/backend/src/routes/project.routes.js): `backend/src/routes/project.routes.js`
- [Project validation](https://github.com/mantu0019/3_soen/blob/main/backend/src/services/project.services.js): `backend/src/services/project.services.js`
- [Project controller](https://github.com/mantu0019/3_soen/blob/main/backend/src/controller/project.controller.js): `backend/src/controller/project.controller.js`
- [Express application](https://github.com/mantu0019/3_soen/blob/main/backend/src/app.js): `backend/src/app.js`

### Persistence

- [User records](https://github.com/mantu0019/3_soen/blob/main/backend/src/models/user.model.js): `backend/src/models/user.model.js`
- [Project records](https://github.com/mantu0019/3_soen/blob/main/backend/src/models/project.model.js): `backend/src/models/project.model.js`
- [Redis client](https://github.com/mantu0019/3_soen/blob/main/backend/src/services/redies.services.js): `backend/src/services/redies.services.js`

### Other components

- **User**
- **Redis**
- **MongoDB**

## Connections

- User → Client routes: uses (evidence: `frontend/src/app/AppRoutes.jsx`)
- Client routes → Login and register: routes to (evidence: `frontend/src/app/AppRoutes.jsx`)
- Client routes → Dashboard: routes to (evidence: `frontend/src/app/AppRoutes.jsx`)
- Client routes → Project views: routes to (evidence: `frontend/src/app/AppRoutes.jsx`)
- Login and register → Auth hook: dispatches via (evidence: `frontend/src/features/auth/pages/Login.jsx`)
- Auth hook → Auth actions: dispatches (evidence: `frontend/src/features/auth/hooks/useAuth.jsx`)
- Auth actions → Auth API client: calls (evidence: `frontend/src/features/auth/state/authAction.js`)
- Auth API client → Shared HTTP client: uses (evidence: `frontend/src/features/auth/services/api.js`)
- Auth state → Auth actions: handles (evidence: `frontend/src/features/auth/state/authSlice.jsx`)
- Project views → Project hook: uses (evidence: `frontend/src/features/project/pages/Project.jsx`)
- Project hook → Project actions: dispatches (evidence: `frontend/src/features/project/hook/useProject.jsx`)
- Project actions → Project API client: calls (evidence: `frontend/src/features/project/state/projectAction.js`)
- Project API client → Shared HTTP client: uses (evidence: `frontend/src/features/project/services/api.js`)
- Project state → Project actions: handles (evidence: `frontend/src/features/project/state/projectSlice.jsx`)
- Shared HTTP client → Auth routes: HTTP requests
- Shared HTTP client → Project routes: HTTP requests
- Express application → Auth routes: mounts (evidence: `backend/src/app.js`)
- Express application → Project routes: mounts (evidence: `backend/src/app.js`)
- Auth routes → Auth validation: validates (evidence: `backend/src/routes/auth.routes.js`)
- Auth routes → Token middleware: authenticates (evidence: `backend/src/routes/auth.routes.js`)
- Auth routes → User controller: dispatches (evidence: `backend/src/routes/auth.routes.js`)
- User controller → User records: reads and writes (evidence: `backend/src/controller/user.controller.js`)
- User controller → Redis client: blacklists tokens (evidence: `backend/src/controller/user.controller.js`)
- Token middleware → Redis client: checks blacklist (evidence: `backend/src/middleware/auth.middleware.js`)
- Token middleware → User records: loads user (evidence: `backend/src/middleware/auth.middleware.js`)
- Project routes → Project validation: validates (evidence: `backend/src/routes/project.routes.js`)
- Project routes → Token middleware: authenticates (evidence: `backend/src/routes/project.routes.js`)
- Project routes → Project controller: dispatches (evidence: `backend/src/routes/project.routes.js`)
- Project controller → Project records: reads and writes (evidence: `backend/src/controller/project.controller.js`)
- Project controller → User records: loads users (evidence: `backend/src/controller/project.controller.js`)
- Redis client → Redis: connects
- User records → MongoDB: persists records
- Project records → MongoDB: persists records
