# omarenab/eg-auth-assessment architecture

> Architecture diagram of the GitHub repository omarenab/eg-auth-assessment, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/omarenab/eg-auth-assessment
- Repository: https://github.com/omarenab/eg-auth-assessment

## Overview

This is a React/NestJS authentication application. Users register or sign in through validated forms; the frontend auth context calls the API, the backend verifies credentials or creates an account, and successful authentication sets a cookie. Authenticated users can reach the protected home page, which loads their profile through the guarded users endpoint. The graph also shows user persistence and backend request throttling. Some links reflect documented HTTP endpoints; unsampled integration details are omitted.

Main entry points: [`frontend/src/router.tsx`](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/router.tsx) (Page router), [`backend/src/users/users.service.ts`](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/users/users.service.ts) (User service), [`frontend/src/Context/AuthContext.tsx`](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Context/AuthContext.tsx) (Auth context), [`frontend/src/services/auth.service.ts`](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/services/auth.service.ts) (Auth API client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Frontend"]
  node_app["App shell<br/>[App.tsx]"]
  node_router["Page router<br/>[router.tsx]"]
  node_signin["Sign-in page<br/>[SignIn.tsx]"]
  node_signup["Sign-up page<br/>[SignUp.tsx]"]
  node_home["Home page<br/>[Home.tsx]"]
  node_protected["Route guard<br/>[ProtectedRoute.tsx]"]
  node_loginform["Login form<br/>[LoginForm.tsx]"]
  node_signupform["Registration form<br/>[SignUpForm.tsx]"]
  node_validation["Form validation"]
  node_authstate["Auth context<br/>[AuthContext.tsx]"]
  node_authapi["Auth API client<br/>[auth.service.ts]"]
  node_http["HTTP client<br/>[api.service.ts]"]
end

subgraph group_backend["Backend"]
  node_authcontroller["Auth endpoints<br/>[auth.controller.ts]"]
  node_userscontroller["Profile endpoints"]
  node_throttling["Request throttling<br/>[app.module.ts]"]
end

subgraph group_identity["Identity and users"]
  node_authservice["Auth service<br/>[auth.service.ts]"]
  node_jwtguard["JWT guard<br/>[jwt-auth.guard.ts]"]
  node_jwtstrategy["JWT strategy<br/>[jwt.strategy.ts]"]
  node_usersservice["User service<br/>[users.service.ts]"]
  node_userrecord["User schema<br/>[user.schema.ts]"]
end

subgraph group_external["External services"]
  node_mongodb[("MongoDB")]
  node_jwt["JWT service"]
  node_bcrypt["Bcrypt"]
end

node_visitor(("Visitor"))

node_visitor -->|"uses"| node_app
node_app -->|"renders"| node_router
node_router -->|"routes to"| node_signin
node_router -->|"routes to"| node_signup
node_router -->|"protects"| node_protected
node_router -->|"routes to"| node_home
node_signin -->|"renders"| node_loginform
node_signup -->|"renders"| node_signupform
node_loginform -->|"validates with"| node_validation
node_signupform -->|"validates with"| node_validation
node_loginform -->|"submits to"| node_authstate
node_signupform -->|"submits to"| node_authstate
node_protected -->|"checks"| node_authstate
node_home -->|"reads state"| node_authstate
node_authstate -->|"calls"| node_authapi
node_authapi -->|"sends requests"| node_http
node_authapi -->|"calls endpoints"| node_authcontroller
node_authapi -->|"requests profile"| node_userscontroller
node_authcontroller -->|"delegates to"| node_authservice
node_authservice -->|"looks up or creates"| node_usersservice
node_authservice -->|"hashes and compares"| node_bcrypt
node_authservice -->|"signs token"| node_jwt
node_userscontroller -->|"guards profile"| node_jwtguard
node_userscontroller -->|"loads profile"| node_usersservice
node_jwtstrategy -->|"uses"| node_usersservice
node_usersservice -->|"queries"| node_userrecord
node_usersservice -->|"reads and writes"| node_mongodb
node_throttling -.->|"limits requests"| node_authcontroller

click node_app "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/App.tsx"
click node_router "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/router.tsx"
click node_signin "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/pages/SignIn.tsx"
click node_signup "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/pages/SignUp.tsx"
click node_home "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/pages/Home.tsx"
click node_protected "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Components/main/ProtectedRoute.tsx"
click node_loginform "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Components/main/LoginForm.tsx"
click node_signupform "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Components/main/SignUpForm.tsx"
click node_validation "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/schemas/auth.validationschema.ts"
click node_authstate "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Context/AuthContext.tsx"
click node_authapi "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/services/auth.service.ts"
click node_http "https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/services/api.service.ts"
click node_authcontroller "https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/auth/auth.controller.ts"
click node_authservice "https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/auth/auth.service.ts"
click node_userscontroller "https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/users/users.controller.ts"
click node_jwtguard "https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/auth/guards/jwt-auth.guard.ts"
click node_jwtstrategy "https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/auth/strategies/jwt.strategy.ts"
click node_usersservice "https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/users/users.service.ts"
click node_userrecord "https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/users/schemas/user.schema.ts"
click node_throttling "https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/app.module.ts"

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_app,node_router,node_signin,node_signup,node_home,node_protected,node_loginform,node_signupform,node_validation,node_authstate,node_authapi,node_http toneBlue
class node_authcontroller,node_userscontroller,node_throttling toneAmber
class node_authservice,node_jwtguard,node_jwtstrategy,node_usersservice,node_userrecord toneMint
class node_mongodb,node_jwt,node_bcrypt toneRose
class node_visitor toneIndigo
```

## Components

### Frontend

- [App shell](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Page router](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/router.tsx): `frontend/src/router.tsx`
- [Sign-in page](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/pages/SignIn.tsx): `frontend/src/pages/SignIn.tsx`
- [Sign-up page](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/pages/SignUp.tsx): `frontend/src/pages/SignUp.tsx`
- [Home page](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/pages/Home.tsx): `frontend/src/pages/Home.tsx`
- [Route guard](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Components/main/ProtectedRoute.tsx): `frontend/src/Components/main/ProtectedRoute.tsx`
- [Login form](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Components/main/LoginForm.tsx): `frontend/src/Components/main/LoginForm.tsx`
- [Registration form](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Components/main/SignUpForm.tsx): `frontend/src/Components/main/SignUpForm.tsx`
- [Form validation](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/schemas/auth.validationschema.ts): `frontend/src/schemas/auth.validationschema.ts`
- [Auth context](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/Context/AuthContext.tsx): `frontend/src/Context/AuthContext.tsx`
- [Auth API client](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/services/auth.service.ts): `frontend/src/services/auth.service.ts`
- [HTTP client](https://github.com/omarenab/eg-auth-assessment/blob/main/frontend/src/services/api.service.ts): `frontend/src/services/api.service.ts`

### Backend

- [Auth endpoints](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/auth/auth.controller.ts): `backend/src/auth/auth.controller.ts`
- [Profile endpoints](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/users/users.controller.ts): `backend/src/users/users.controller.ts`
- [Request throttling](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/app.module.ts): `backend/src/app.module.ts`

### Identity and users

- [Auth service](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/auth/auth.service.ts): `backend/src/auth/auth.service.ts`
- [JWT guard](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/auth/guards/jwt-auth.guard.ts): `backend/src/auth/guards/jwt-auth.guard.ts`
- [JWT strategy](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/auth/strategies/jwt.strategy.ts): `backend/src/auth/strategies/jwt.strategy.ts`
- [User service](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/users/users.service.ts): `backend/src/users/users.service.ts`
- [User schema](https://github.com/omarenab/eg-auth-assessment/blob/main/backend/src/users/schemas/user.schema.ts): `backend/src/users/schemas/user.schema.ts`

### External services

- **MongoDB**
- **JWT service**
- **Bcrypt**

### Other components

- **Visitor**

## Connections

- Visitor → App shell: uses
- App shell → Page router: renders (evidence: `frontend/src/App.tsx`)
- Page router → Sign-in page: routes to (evidence: `frontend/src/router.tsx`)
- Page router → Sign-up page: routes to (evidence: `frontend/src/router.tsx`)
- Page router → Route guard: protects (evidence: `frontend/src/router.tsx`)
- Page router → Home page: routes to (evidence: `frontend/src/router.tsx`)
- Sign-in page → Login form: renders (evidence: `frontend/src/pages/SignIn.tsx`)
- Sign-up page → Registration form: renders (evidence: `frontend/src/pages/SignUp.tsx`)
- Login form → Form validation: validates with (evidence: `frontend/src/Components/main/LoginForm.tsx`)
- Registration form → Form validation: validates with (evidence: `frontend/src/Components/main/SignUpForm.tsx`)
- Login form → Auth context: submits to (evidence: `frontend/src/Components/main/LoginForm.tsx`)
- Registration form → Auth context: submits to (evidence: `frontend/src/Components/main/SignUpForm.tsx`)
- Route guard → Auth context: checks (evidence: `frontend/src/Components/main/ProtectedRoute.tsx`)
- Home page → Auth context: reads state (evidence: `frontend/src/pages/Home.tsx`)
- Auth context → Auth API client: calls (evidence: `frontend/src/Context/AuthContext.tsx`)
- Auth API client → HTTP client: sends requests (evidence: `frontend/src/services/auth.service.ts`)
- Auth API client → Auth endpoints: calls endpoints (evidence: `frontend/src/services/auth.service.ts`)
- Auth API client → Profile endpoints: requests profile (evidence: `frontend/src/services/auth.service.ts`)
- Auth endpoints → Auth service: delegates to (evidence: `backend/src/auth/auth.controller.ts`)
- Auth service → User service: looks up or creates (evidence: `backend/src/auth/auth.service.ts`)
- Auth service → Bcrypt: hashes and compares (evidence: `backend/src/auth/auth.service.ts`)
- Auth service → JWT service: signs token (evidence: `backend/src/auth/auth.service.ts`)
- Profile endpoints → JWT guard: guards profile (evidence: `backend/src/users/users.controller.ts`)
- Profile endpoints → User service: loads profile (evidence: `backend/src/users/users.controller.ts`)
- JWT strategy → User service: uses (evidence: `backend/src/auth/strategies/jwt.strategy.ts`)
- User service → User schema: queries (evidence: `backend/src/users/users.service.ts`)
- User service → MongoDB: reads and writes (evidence: `backend/src/users/users.service.ts`)
- Request throttling → Auth endpoints: limits requests (evidence: `backend/src/app.module.ts`)
