# <Project Name>

<one-paragraph description — what the app does and for whom (from the brief).>

> Built on the AAIT Laravel base — admin dashboard (Blade + session) + versioned REST API (Sanctum),
> Arabic + English. Copy this file to the **project root `README.md`** and fill it at project start;
> refresh the Features / Structure / API sections as sprints land.

## ✨ Features
- `<feature>` — <one line>

## 🧱 Tech stack
Laravel 12 · PHP 8.3 · MySQL · Blade + Tailwind v4 (Vite) · **Sanctum** (API auth) ·
**Astrotomic Translatable** (i18n) · **Spatie Media Library** (uploads) · Maatwebsite Excel / PHPWord (exports).

## 👥 Audiences / apps
- `<user>` (app + web) · `<provider>` (panel) · `<delegate>` (app) …
- **Auth model:** `<multi-auth — model + Sanctum guard per audience (default) | one users + user_type>`

## 🗂️ Project structure
```
app/
├── Models/                        # entities (+ {Model}Translation for translatable)
├── Enums/                         # backed enums (GeneralEnumTrait)
├── Http/
│   ├── Controllers/{Admin, Api/V1}   # thin controllers (flows = subfolders)
│   ├── Requests/{Admin, Api}         # Form Request validation
│   └── Resources/Api/V1              # API resources/collections
├── Services/{Admin, <domain>}     # business logic
├── Jobs · Events · Notifications · Observers · Policies
└── Traits/{Response, Upload, …}
database/{migrations/<domain>, schema/*.json, seeders, factories}
resources/views/{admin/<module>, landing}
routes/{admin.php, api/v1/*.php}   # API auto-mounted
lang/{ar, en}                      # ar default
docs/{project, build, project-init}
```
> Replace with the **real domain modules** once built (list the main entities + their key files).

## 🚀 Getting started
```bash
composer install && npm install
cp .env.example .env && php artisan key:generate
php artisan migrate:fresh --seed
composer dev            # app + queue + vite   (or: php artisan serve & npm run dev)
```

## 🔌 API
- Base URL: `http://127.0.0.1:8000/api/v1/` · Auth: **Sanctum** (`Authorization: Bearer <token>`) · Localization: `?lang=ar|en`
- Standard envelope via `app/Traits/Response/` (`message` + `data`).
- Postman collection: `docs/postman/<project>.postman_collection.json`
- Endpoint plans: `docs/project/api/<audience>/<flow>/`

## 🛠️ Admin dashboard
- `/admin` — session auth (`auth:admin`) + role/permission RBAC. Sidebar: `config/sidebar_routes.php`.

## 🧰 Dev tools (this project ships)
- **Schema designer:** `/schema-designer` (visual ERD, per-feature JSON) · **Kanban:** `/kanban` (live sprint/plan progress).
- **Design:** <Figma link(s)>

## 📚 Internal docs
- Agent orientation (read-first): `docs/project/CONTEXT.md`
- Build history (per sprint): `docs/project/CHANGELOG.md`
- Build playbooks: `docs/build/*`