documentação do sistema

This commit is contained in:
Luis Eduardo Estevao
2026-05-05 16:12:52 -03:00
parent bbb5d68af1
commit 4652fea8fc
41 changed files with 1919 additions and 0 deletions

View File

@@ -0,0 +1,23 @@
# Q&A Index
Project type: **web-app**
Generated: 2026-04-29T20:15:44.291Z
## Getting-started
- [How do I set up and run this project?](./getting-started.md)
## Architecture
- [How is the codebase organized?](./project-structure.md)
## Features
- [How does authentication work?](./authentication.md)
- [How is data stored and accessed?](./database.md)
- [What API endpoints are available?](./api-endpoints.md)
## Operations
- [How do I deploy this project?](./deployment.md)

View File

@@ -0,0 +1,11 @@
---
slug: api-endpoints
category: features
generatedAt: 2026-04-29T20:15:39.516Z
---
# What API endpoints are available?
## API Endpoints
### Detected API Files

View File

@@ -0,0 +1,23 @@
---
slug: authentication
category: features
generatedAt: 2026-04-29T20:15:39.516Z
relevantFiles:
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\guards\auth.guard.ts
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\auth\auth-login\auth-login.component.ts
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\auth\auth.module.ts
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\auth\services\auth.service.ts
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\shared\messages\auth-user\auth-user.component.ts
---
# How does authentication work?
## Authentication
### Implementation Details
- Auth-related symbol: AuthGuard
- Auth-related symbol: AuthLoginComponent
- Auth-related symbol: AuthModule
- Auth-related symbol: AuthService
- Auth-related symbol: AuthUserComponent

View File

@@ -0,0 +1,22 @@
---
slug: database
category: features
generatedAt: 2026-04-29T20:15:39.516Z
relevantFiles:
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\sales\store\models\action.model.ts
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\models\cart-itens.model.ts
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\models\cart.model.ts
- C:\Users\luis.estevao\AppData\Local\Programs\Antigravity\src\app\sales\components\create-customer-modal\create-customer-modal.component.ts
---
# How is data stored and accessed?
## Database
### Implementation Details
- Database-related symbol: ActionModel
- Database-related symbol: CartItensModel
- Database-related symbol: CartModel
- Database-related symbol: JsonModel
- Data layer detected in architecture

View File

@@ -0,0 +1,21 @@
---
slug: deployment
category: operations
generatedAt: 2026-04-29T20:15:44.246Z
relevantFiles:
- docker-compose.yml
- Dockerfile
---
# How do I deploy this project?
## Deployment
### Docker
This project includes Docker configuration.
```bash
docker build -t app .
docker run -p 3000:3000 app
```

View File

@@ -0,0 +1,32 @@
---
slug: getting-started
category: getting-started
generatedAt: 2026-04-29T20:11:48.572Z
---
# How do I set up and run this project?
## Getting Started
### Prerequisites
- Node.js (LTS version recommended)
- npm
### Installation
```bash
# Clone the repository
git clone <repository-url>
cd Vendaweb-portal
# Install dependencies
npm install
```
### Running
```bash
# See package.json for available scripts
npm run <script-name>
```

View File

@@ -0,0 +1,15 @@
---
slug: project-structure
category: architecture
generatedAt: 2026-04-29T20:15:39.515Z
---
# How is the codebase organized?
## Project Structure
```
e2e/
k8s/
src/
```