documentação do sistema
This commit is contained in:
49
.context/docs/project-overview.md
Normal file
49
.context/docs/project-overview.md
Normal file
@@ -0,0 +1,49 @@
|
||||
---
|
||||
type: doc
|
||||
name: project-overview
|
||||
description: High-level overview of the project, its purpose, and key components
|
||||
category: overview
|
||||
generated: 2026-04-29
|
||||
status: active
|
||||
scaffoldVersion: "2.0.0"
|
||||
---
|
||||
|
||||
# Project Overview
|
||||
This project is an Angular-based B2B/B2C Sales Portal (VendaWeb). It empowers sellers to manage customers, browse product catalogs, assemble carts, and process orders, while also offering CRM, Partner Management, and administrative capabilities.
|
||||
|
||||
> **Detailed Analysis**: For complete symbol counts, architecture layers, and dependency graphs, see [`codebase-map.json`](./codebase-map.json).
|
||||
|
||||
## Quick Facts
|
||||
- **Root**: `/`
|
||||
- **Languages**: TypeScript, HTML, SCSS
|
||||
- **Framework**: Angular
|
||||
- **State Management**: NgRx (Redux pattern)
|
||||
|
||||
## Entry Points
|
||||
- [AppModule](file:///d:/desenvolvimento/Simplifique/vendaweb/Vendaweb-portal/src/app/app.module.ts)
|
||||
- [main.ts](file:///d:/desenvolvimento/Simplifique/vendaweb/Vendaweb-portal/src/main.ts)
|
||||
|
||||
## Key Exports
|
||||
- `AppModule`
|
||||
- `SalesModule`
|
||||
- `PartnersModule`
|
||||
|
||||
## File Structure & Code Organization
|
||||
- `src/app/sales/` — Core point-of-sale functionality (cart, products, checkout).
|
||||
- `src/app/crm/` — Customer management interfaces.
|
||||
- `src/app/partners/` — Partner reporting, commissions, and management.
|
||||
- `src/app/financial/` — Financial operations and checkout.
|
||||
- `src/app/models/` — TypeScript interfaces representing business entities.
|
||||
- `src/app/shared/` — Reusable UI components, interceptors, and services.
|
||||
- `src/app/auth/` — Authentication and login flows.
|
||||
|
||||
## Technology Stack Summary
|
||||
- **Frontend**: Angular
|
||||
- **State**: NgRx Store
|
||||
- **Styling**: SCSS, Kendo UI (`kendo-ui-license.txt` indicates Kendo usage)
|
||||
- **Tooling**: Angular CLI, TypeScript, npm
|
||||
|
||||
## Getting Started Checklist
|
||||
1. Install dependencies with `npm install`.
|
||||
2. Run the application locally with `npm run start` or `ng serve`.
|
||||
3. Navigate to `http://localhost:4200` to view the app.
|
||||
Reference in New Issue
Block a user