OATERSIntegrated ERP System

About OATERS ​

OATERS is a modern, modular ERP (Enterprise Resource Planning) system built on Laravel, designed to streamline business operations across multiple domains. The system integrates six powerful modules, each represented by a precious gemstone, working together to provide a complete business management solution.

🎯 System Overview ​

OATERS stands for a comprehensive suite of business management tools:

• Onyx - Production & Manufacturing
• Amethyst - E-commerce & Sales
• Topaz - Financial Management
• Emerald - Project Management
• Ruby - Human Resources
• Sapphire - User & Tenant Management

✨ Key Features ​

• 🔧 Modular Architecture: Each module operates independently while seamlessly integrating with others
• 🏢 Multi-Tenant: Built-in support for multiple organizations with isolated data via Stancl Tenancy
• 🔒 Secure: Enterprise-grade security with role-based access control using Spatie Permission
• 🌍 Multi-Language: Full localization support via Astrotomic Translatable
• 📊 Analytics: Comprehensive reporting and business intelligence across all modules
• 🚀 Scalable: Built on Laravel for performance and scalability
• 🎨 Modern UI: Clean, intuitive interface for enhanced user experience
• 📱 Responsive: Works seamlessly across desktop, tablet, and mobile devices
• 🔌 API-First: RESTful APIs for integration with third-party systems

🏗️ Technology Stack ​

• Backend: Laravel 10+ (PHP 8.1+)
• Module System: nwidart/laravel-modules (^10.0)
• Database: MySQL/PostgreSQL with tenant isolation
• Multi-Tenancy: stancl/tenancy (^3.8)
• Permissions: spatie/laravel-permission (^6.4)
• Localization: astrotomic/laravel-translatable (^11.12)
• Frontend: Blade Templates / Vue.js 3
• Build Tool: Vite (Rolldown)
• Authentication: Laravel Sanctum / Passport
• Queue System: Redis / Laravel Queue
• Caching: Redis / Memcached
• Documentation: VitePress

🏛️ Module Architecture ​

The OATERS system is built on three foundational layers:

1. Core Layer ​

• Common Module: Shared entities (Contacts, Addresses, Countries, etc.)
• Sapphire Module: Authentication, authorization, and multi-tenancy

2. Business Layer (Currently Documented) ​

• Ruby Module: Human Resources ✅ Documented
• Additional business modules in development

3. Business Layer (In Development) ​

• Onyx Module: Production & Manufacturing 🚧 Coming soon
• Amethyst Module: E-commerce & Sales 🚧 Coming soon
• Topaz Module: Financial Management 🚧 Coming soon
• Emerald Module: Project Management 🚧 Coming soon

🎪 Module Integration ​

The OATERS system is designed with integration at its core:

• Common provides shared entities (Contacts, Addresses, etc.) used across all modules
• Sapphire provides centralized authentication and tenant management for all modules
• Ruby integrates with Common for employee contact management
• Onyx production data will feed into Amethyst for product availability
• Amethyst sales transactions will integrate with Topaz for financial tracking
• Emerald project costs and budgets will sync with Topaz
• Ruby payroll and HR expenses will integrate with Topaz financial reports
• Cross-module reporting provides unified business insights

📚 Available Documentation ​

Completed Modules ​

• Sapphire Module - Authentication, multi-tenancy, and user management
• Ruby Module - Human resources and employee management

Modules In Development ​

Documentation will be added as modules are developed:

• Onyx Module - Production & Manufacturing (coming soon)
• Amethyst Module - E-commerce & Sales (coming soon)
• Topaz Module - Financial Management (coming soon)
• Emerald Module - Project Management (coming soon)

Development Guides ​

• Frontend Guide - Quick start for frontend development
• Frontend Architecture - Understanding the Vue + Blade architecture
• Component Development - Building Vue and Blade components

🔗 Key Integrations ​

Sapphire ↔ Common ​

• Users link to Contacts for extended information
• Contacts can have roles and permissions
• Shared authentication across modules

Ruby ↔ Common ​

• Employees are stored as Contacts
• Departments link to Contacts for managers and staff
• Applicants extend Contact information

Ruby ↔ Sapphire ​

• Authentication and session management
• Permission-based access control
• Tenant-scoped data isolation

🚧 Development Status ​

OATERS is currently under active development. The following components are available:

✅ Completed:

• Sapphire module (authentication, multi-tenancy)
• Ruby module (HR management foundation)
• Common module (shared entities)
• Documentation infrastructure (VitePress)

🔄 In Progress:

• Ruby module enhancements (payroll, leave approval)
• Additional business modules

📋 Planned:

• Onyx, Amethyst, Topaz, and Emerald modules
• API documentation
• Installation and deployment guides
• Backend development documentation
• Database schema documentation

🤝 Contributing ​

OATERS is under active development. We welcome contributions from the community!

As documentation is completed, contribution guidelines will be added here.

📄 License ​

OATERS is open-source software. Please refer to the LICENSE file for more information.