Backend API for XetaSuite - Multi-Tenant Facility Management ERP
XetaSuite is a multi-tenant ERP (Enterprise Resource Planning) designed for comprehensive facility, equipment, and inventory management. This professional solution enables businesses to efficiently manage their sites, zones, materials, stock, and interventions (maintenance, cleaning, incidents).
XetaSuite is ideal for:
| Industry | Use Cases |
|---|---|
| 🏢 Facility Management | Building management, workspaces, meeting rooms |
| 🏭 Manufacturing & Production | Equipment tracking, preventive maintenance, spare parts management |
| 🏥 Healthcare & Hospitals | Medical equipment inventory, equipment traceability, cleaning schedules |
| 🏫 Education | School furniture management, IT equipment tracking |
| 🏨 Hospitality & Catering | Linen management, kitchen equipment, room maintenance |
| 🏬 Retail & Commerce | Multi-store management, product inventory, incident tracking |
| 🏗️ Construction | Construction equipment management, tool tracking |
| 🚚 Logistics & Warehousing | Storage zone management, stock movement tracking |
- Multiple sites: Manage several locations from a single interface
- Headquarters site: Centralized administration with global access
- Per-site permissions: Each user has specific roles/permissions per site
- Dynamic site switching: Switch between sites without logging out
- Nested zones: Unlimited tree structure (Building → Floor → Room)
- Hierarchical visualization: Intuitive tree navigation
- Property inheritance: Configuration propagated to child zones
- Complete records: Reference, brand, model, serial number, acquisition date
- Zone assignment: Precise location for each piece of equipment
- QR Codes: Automatic generation for quick identification
- Full history: Traceability of all interventions on each material
- Items catalog: Complete catalog with references, descriptions, units
- Stock movements: Entries, exits, transfers with full traceability
- QR Codes: Automatic generation for quick identification
- Price history: Track purchase cost evolution
- Stock alerts: Configurable thresholds for reordering
- Unified company model: Companies can be item providers, maintenance contractors, or both
- Type-based filtering: Filter companies by their role (ITEM_PROVIDER, MAINTENANCE_PROVIDER)
- Headquarters management: Centralized database managed from HQ site
- Full traceability: Track all items and maintenances linked to each company
- Scheduling: Preventive maintenance with configurable recurrence
- Intervention tracking: Statuses (scheduled, in progress, completed, cancelled)
- External contractors: Maintenance company management
- Costs & budgets: Track expenses per intervention
- Cleaning schedules: Configurable frequencies per zone
- Service tracking: Validation and history of cleaning sessions
- Quality control: Notes and comments on services
- Simplified reporting: Quick reporting with location
- Priority levels: Critical, high, medium, low
- Resolution workflow: Statuses and team assignment
- Statistics: Dashboards and indicators
- Secure authentication: Laravel Sanctum (SPA) + Fortify
- Customizable roles: Admin, Manager, Operator, etc.
- Granular permissions: Fine-grained access control per feature
- Per-site permissions: Users can have different roles depending on the site
- Multi-language: French and English included
- User preferences: Language saved per profile
- Extensible: Easy addition of new languages
- Real-time notifications: Alerts and important events
- Notification center: Searchable history
- Read/unread marking: Individual and bulk management
- Unified calendar view: Aggregated view combining calendar events, maintenances, and incidents
- Event categories: Organize events with customizable categories (name, color, description)
- Full CRUD: Create, edit, delete events with drag & drop support
- Date range filtering: Display events within specific time periods
- Today's events: Quick banner showing current day's events
- All-day events: Support for full-day or time-specific events
- Custom colors: Override category color with custom event colors
- Status-based colors: Maintenances and incidents automatically colored by status
- Unified search: Search across all resources from a single endpoint
- Multi-type results: Materials, zones, items, incidents, maintenances, companies, sites
- Permission-aware: Results filtered based on user's permissions
- Site-scoped: Regular users see only their site's data, HQ users see all
| Component | Technology | Version |
|---|---|---|
| Framework | Laravel | 12.x |
| Language | PHP | 8.4+ |
| Database | PostgreSQL | 18+ |
| Authentication | Laravel Sanctum + Fortify | 4.x / 1.x |
| Permissions | spatie/laravel-permission | 6.x |
| Testing | Pest PHP | 4.x |
| QR Codes | endroid/qr-code | 6.x |
| Activity Log | spatie/laravel-activitylog | 4.x |
app/
├── Actions/{Domain}/ # Single-responsibility action classes
├── Enums/{Domain}/ # PHP enums with labels
├── Http/
│ ├── Controllers/Api/V1/ # Versioned API controllers
│ ├── Requests/V1/ # Form Requests with validation
│ ├── Resources/V1/ # JSON transformers
│ └── Middleware/ # Custom middleware
├── Models/ # Eloquent models
├── Observers/ # Lifecycle hooks
├── Policies/ # Resource authorization
└── Services/ # Complex business logic
Site (tenant)
├── Zone (hierarchical, self-referential)
│ ├── Material (equipment)
│ │ ├── Cleanings
│ │ ├── Incidents
│ │ └── Maintenances
├── Items (stock)
│ ├── ItemMovements
│ └── ItemPrices
└── Users (with per-site roles)
Headquarters (HQ Site)
└── Companies (unified: item providers + maintenance contractors)
├── types: [ITEM_PROVIDER, MAINTENANCE_PROVIDER]
├── → Items (as supplier)
└── → Maintenances (as contractor)
- PHP 8.4 or higher
- Composer 2.x
- PostgreSQL 18 or higher
# Clone the repository
git clone https://github.com/XetaIO/XetaSuite-core.git
cd XetaSuite-core
# Install dependencies
composer install
# Configure environment
cp .env.example .env
php artisan key:generate
# Configure database in .env# DB_CONNECTION=pgsql# DB_DATABASE=xetasuite# ...# Run migrations and seeders
php artisan migrate --seed
# Start development server
composer run dev# ApplicationAPP_URL=https://xetasuite.testSPA_URL=http://localhost:5173# DatabaseDB_CONNECTION=pgsqlDB_DATABASE=xetasuite# Sanctum (SPA)SANCTUM_STATEFUL_DOMAINS=localhost:5173,xetasuite.test# SessionSESSION_DRIVER=databaseSESSION_DOMAIN=.xetasuite.test# Demo mode (optional)DEMO_MODE=falseXetaSuite uses Pest PHP for testing with comprehensive coverage:
# Run all tests
php artisan test# Run tests with filter
php artisan test --filter=CompanyController
# Run tests by directory
php artisan test tests/Feature/Observers/The API follows REST conventions with versioning (/api/v1/). Main endpoints:
| Endpoint | Description |
|---|---|
POST /api/v1/auth/login | Authentication |
GET /api/v1/user | Current user |
PATCH /api/v1/user/site | Switch site |
GET /api/v1/sites | List sites |
GET /api/v1/zones | Current site zones |
GET /api/v1/materials | Materials |
GET /api/v1/items | Items/Stock |
GET /api/v1/maintenances | Maintenances |
GET /api/v1/incidents | Incidents |
GET /api/v1/cleanings | Cleanings |
GET /api/v1/companies | Companies (item providers + contractors, HQ only) |
XetaSuite can be deployed in demonstration mode:
DEMO_MODE=trueIn demo mode:
- Destructive actions are blocked (deleting sites, users, etc.)
- Database is reset every 6 hours
- Test accounts available:
admin@xetasuite.demo,manager@xetasuite.demo,user@xetasuite.demo
Contributions are welcome! Please review the contribution guide before submitting a Pull Request.
# Format code before committing
vendor/bin/pint --dirtyXetaSuite is open-source software licensed under the MIT license.
- React Frontend: XetaSuite-React
- Issues: GitHub Issues