63 lines
3.1 KiB
Markdown
63 lines
3.1 KiB
Markdown
# Repository Map
|
|
|
|
## Repository Structure & Overview
|
|
This repository contains an active e-commerce application stack with nested standalone directories and placeholder artifacts.
|
|
|
|
- **Root Directory**: `c:\Users\parsa\Desktop\work\caninairan`
|
|
- **Initial Git Branch**: `develop`
|
|
- **Initial HEAD Commit**: `715873b2ecc3a72ba974bb2a2be87c5ba82bd4e7`
|
|
- **Git Working Tree Status**: Contains untracked directories `docs/` and `frontend/`. No tracked files are modified.
|
|
- **Monorepo / Multi-repository Classification**: Hybrid single-repository setup.
|
|
- **Package Manager**: npm (`package-lock.json` present in root and `backend/`).
|
|
|
|
---
|
|
|
|
## Active Applications & Non-Auditable Scopes
|
|
|
|
### 1. Active Customer Storefront: React 19 + Vite Application
|
|
- **Status**: ACTIVE APPLICATION
|
|
- **Path**: `.` (`src/`, `index.html`, `vite.config.ts`, `package.json`)
|
|
- **Technology**: React 19, Vite 6, TypeScript 5.8, Tailwind CSS v4, Zustand 5, Axios, Lucide React, Motion.
|
|
- **Description**: Customer e-commerce interface for Canino Iran pet health & supplement products, including catalog browsing, cart management, dosage calculator, pet wallet, charity counter, and health journal UI.
|
|
|
|
### 2. Active Backend Service: NestJS Application
|
|
- **Status**: ACTIVE APPLICATION
|
|
- **Path**: `backend/` (`backend/src/`, `backend/package.json`, `backend/prisma/`)
|
|
- **Technology**: NestJS 11, Prisma ORM 5.22, PostgreSQL, Redis (`ioredis`), JWT, Passport, Swagger, Class Validator, Throttler.
|
|
- **Description**: RESTful API supporting authentication, users, pets, products, orders, wallet transactions, and administrative settings.
|
|
|
|
### 3. Excluded Placeholder / Non-Auditable Directories
|
|
- **`frontend/application`**: NON-AUDITABLE / GENERATED PLACEHOLDER. Contains build/cache artifacts (`.next/`, `tsconfig.tsbuildinfo`, `next-env.d.ts`, `node_modules/`). Lacks root `package.json` or source code files (`src/` or `app/`). **EXCLUDED FROM SOURCE AUDIT.**
|
|
- **`frontend/admin-panel`**: NON-AUDITABLE PLACEHOLDER. Contains only `node_modules/` directory without `package.json` or source files. **EXCLUDED FROM SOURCE AUDIT.**
|
|
|
|
---
|
|
|
|
## Mandatory Global Audit Exclusions
|
|
All Phase 2 auditors must strictly ignore generated code, build output, dependencies, and temporary caches:
|
|
- `**/node_modules/**`
|
|
- `**/.next/**`
|
|
- `**/dist/**`
|
|
- `**/build/**`
|
|
- `**/coverage/**`
|
|
- `**/.turbo/**`
|
|
- `**/.cache/**`
|
|
- `**/*.tsbuildinfo`
|
|
- Generated Prisma client (`node_modules/@prisma/client` & `.prisma/client`)
|
|
- Generated API models and minified JavaScript bundles
|
|
|
|
---
|
|
|
|
## Important Configuration & Infrastructure Files
|
|
|
|
- **Docker & Containerization**: `Dockerfile`, `docker-compose.yml`, `backend/Dockerfile`, `.dockerignore`, `backend/.dockerignore`
|
|
- **Proxy & Observability**: `nginx.conf`, `prometheus.yml`
|
|
- **Database & Data Modeling**: `backend/prisma/schema.prisma`
|
|
- **API Specs**: `swagger.yml`, NestJS Swagger (`@nestjs/swagger`)
|
|
- **Repository Documentation**: `README.md`, `DATABASE_SCHEMA.md`, `BACKEND_INTEGRATION.md`
|
|
- **Environment Templates**: `.env.example`, `backend/.env` (sensitive/uncommitted)
|
|
|
|
---
|
|
|
|
## Documentation Governance
|
|
- **Audit Deliverable Directory**: `docs/audit/`
|