# lucianocharlesdesouza/vue-auth-permissions-basic architecture

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

- Interactive diagram: https://gitdiagram.com/lucianocharlesdesouza/vue-auth-permissions-basic
- Repository: https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic

## Overview

This Vue application provides login, persisted authentication state, permission-aware routing and navigation, and a Users page that checks the current token. The main flow is browser → login view → Pinia auth store → Axios API client → PHP API; authenticated routes are guarded, and the authenticated layout supplies permission-filtered navigation. The README documents the PHP server and API-backed login/logout, while the sampled Users view also calls the API for identity verification. Dashboard behavior is not shown, so it is represented only as a routed screen.

Main entry points: [`src/router/index.js`](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/router/index.js) (Route configuration), [`src/services/api.js`](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/services/api.js) (API client), [`src/stores/authStore.js`](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/stores/authStore.js) (Auth store), [`src/composables/useMenu.js`](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/composables/useMenu.js) (Menu composable)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Client Application"]
  node_bootstrap["App bootstrap<br/>[main.js]"]
  node_root["Root view<br/>[App.vue]"]
  node_router["Route configuration<br/>[index.js]"]
end

subgraph group_access["Authentication Access"]
  node_guard["Auth guard<br/>[authGuard.js]"]
  node_auth["Auth store<br/>[authStore.js]"]
  node_api["API client<br/>[api.js]"]
end

subgraph group_screens["Application Screens"]
  node_layout["Authenticated layout"]
  node_menu["Permission menu<br/>[MenuComponent.vue]"]
  node_menuhelper["Menu composable<br/>[useMenu.js]"]
  node_login["Login screen<br/>[LoginView.vue]"]
  node_dashboard["Dashboard screen<br/>[DashboardView.vue]"]
  node_users["Users screen<br/>[UsersView.vue]"]
end

subgraph group_backend["PHP Backend"]
  node_php["PHP API<br/>[api.php]"]
end

node_browser(("Browser user"))
node_toast["Toast notifications"]

node_browser -->|"opens login"| node_login
node_bootstrap -->|"mounts"| node_root
node_bootstrap -->|"installs"| node_router
node_root -->|"renders routes"| node_router
node_router -->|"registers guard"| node_guard
node_guard -->|"checks access"| node_auth
node_router -->|"routes to"| node_login
node_router -->|"routes to"| node_layout
node_router -->|"routes to"| node_dashboard
node_router -->|"routes to"| node_users
node_login -->|"submits credentials"| node_auth
node_auth -->|"requests login"| node_api
node_api -->|"sends API requests"| node_php
node_layout -->|"renders"| node_menu
node_menu -->|"uses"| node_menuhelper
node_menuhelper -->|"checks permissions"| node_auth
node_menuhelper -->|"redirects logout"| node_router
node_users -->|"displays account state"| node_auth
node_users -->|"verifies token"| node_api
node_api -->|"refreshes or clears session"| node_auth
node_api -->|"redirects on logout"| node_router
node_api -->|"shows feedback"| node_toast

click node_bootstrap "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/main.js"
click node_root "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/App.vue"
click node_router "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/router/index.js"
click node_guard "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/middlewares/guards/authGuard.js"
click node_auth "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/stores/authStore.js"
click node_api "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/services/api.js"
click node_layout "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/layouts/AuthenticatedLayout.vue"
click node_menu "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/components/MenuComponent.vue"
click node_menuhelper "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/composables/useMenu.js"
click node_login "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/views/LoginView.vue"
click node_dashboard "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/views/DashboardView.vue"
click node_users "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/views/UsersView.vue"
click node_php "https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/api.php"

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_bootstrap,node_root,node_router,node_browser toneBlue
class node_guard,node_auth,node_api toneAmber
class node_layout,node_menu,node_menuhelper,node_login,node_dashboard,node_users toneMint
class node_php toneRose
class node_toast toneIndigo
```

## Components

### Client Application

- [App bootstrap](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/main.js): `src/main.js`
- [Root view](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/App.vue): `src/App.vue`
- [Route configuration](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/router/index.js): `src/router/index.js`

### Authentication Access

- [Auth guard](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/middlewares/guards/authGuard.js): `src/middlewares/guards/authGuard.js`
- [Auth store](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/stores/authStore.js): `src/stores/authStore.js`
- [API client](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/services/api.js): `src/services/api.js`

### Application Screens

- [Authenticated layout](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/layouts/AuthenticatedLayout.vue): `src/layouts/AuthenticatedLayout.vue`
- [Permission menu](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/components/MenuComponent.vue): `src/components/MenuComponent.vue`
- [Menu composable](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/composables/useMenu.js): `src/composables/useMenu.js`
- [Login screen](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/views/LoginView.vue): `src/views/LoginView.vue`
- [Dashboard screen](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/views/DashboardView.vue): `src/views/DashboardView.vue`
- [Users screen](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/src/views/UsersView.vue): `src/views/UsersView.vue`

### PHP Backend

- [PHP API](https://github.com/lucianocharlesdesouza/vue-auth-permissions-basic/blob/main/api.php): `api.php`

### Other components

- **Browser user**
- **Toast notifications**

## Connections

- Browser user → Login screen: opens login (evidence: `README.md`)
- App bootstrap → Root view: mounts (evidence: `src/main.js`)
- App bootstrap → Route configuration: installs (evidence: `src/main.js`)
- Root view → Route configuration: renders routes (evidence: `src/App.vue`)
- Route configuration → Auth guard: registers guard (evidence: `src/router/index.js`)
- Auth guard → Auth store: checks access (evidence: `src/middlewares/guards/authGuard.js`)
- Route configuration → Login screen: routes to (evidence: `src/router/index.js`)
- Route configuration → Authenticated layout: routes to (evidence: `src/router/index.js`)
- Route configuration → Dashboard screen: routes to (evidence: `src/router/index.js`)
- Route configuration → Users screen: routes to (evidence: `src/router/index.js`)
- Login screen → Auth store: submits credentials (evidence: `src/views/LoginView.vue`)
- Auth store → API client: requests login (evidence: `src/stores/authStore.js`)
- API client → PHP API: sends API requests (evidence: `README.md`)
- Authenticated layout → Permission menu: renders (evidence: `src/layouts/AuthenticatedLayout.vue`)
- Permission menu → Menu composable: uses (evidence: `src/components/MenuComponent.vue`)
- Menu composable → Auth store: checks permissions (evidence: `src/composables/useMenu.js`)
- Menu composable → Route configuration: redirects logout (evidence: `src/composables/useMenu.js`)
- Users screen → Auth store: displays account state (evidence: `src/views/UsersView.vue`)
- Users screen → API client: verifies token (evidence: `src/views/UsersView.vue`)
- API client → Auth store: refreshes or clears session (evidence: `src/services/api.js`)
- API client → Route configuration: redirects on logout (evidence: `src/services/api.js`)
- API client → Toast notifications: shows feedback (evidence: `src/services/api.js`)
