Getting Started with Obelaw

Welcome to Obelaw! This guide will help you get up and running with our comprehensive business solutions ecosystem in just a few minutes.

What is Obelaw?

Obelaw is an open-source business solutions ecosystem that provides everything you need to build modern enterprise applications. Built on Laravel and Filament, it offers:

• Complete ERP System - Manage accounting, sales, purchasing, and inventory
• Modular Architecture - Use only what you need, extend what you want
• Developer Tools - Packages for permissions, configurations, and more
• Twist Framework - Our addon system for seamless customization

Prerequisites

Before installing Obelaw, ensure you have:

• PHP 8.1+ with required extensions
• Composer for dependency management
• Node.js 16+ for asset compilation
• MySQL 8.0+ or PostgreSQL 13+
• Redis (recommended for caching and sessions)

Quick Installation

1. Create a New Laravel Project

composer create-project laravel/laravel obelaw-app
cd obelaw-app

2. Install Obelaw Core

composer require obelaw/twist
php artisan twist:setup

3. Configure Your Environment

Update your .env file with your database credentials:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=obelaw_app
DB_USERNAME=your_username
DB_PASSWORD=your_password

4. Run Migrations

php artisan migrate
php artisan twist:migrate

5. Create Admin User

php artisan make:filament-user

6. Start Development Server

php artisan serve

Visit http://localhost:8000/admin to access your Obelaw dashboard!

What's Next?

Now that you have Obelaw installed, explore these areas:

🏢 Business Modules

• ERP Overview - Complete business management
• Accounting - Financial management
• Sales - Customer and order management
• Warehouse - Inventory and logistics

🔧 Developer Tools

• Twist Framework - Addon development
• Packages Overview - Ready-to-use components

🌐 Ecosystem

• Catalog System - Product management
• Contact Management - Customer relationships

Getting Help

• Documentation: Browse our comprehensive guides
• GitHub: Report issues or contribute
• Community: Join our discussions and get support

Architecture Overview

graph TB
    A[Laravel Application] --> B[Filament Admin Panel]
    B --> C[Twist Framework]
    C --> D[ERP Modules]
    C --> E[Business Packages]
    C --> F[Custom Addons]
    
    D --> D1[Accounting]
    D --> D2[Sales]
    D --> D3[Purchasing]
    D --> D4[Warehouse]
    
    E --> E1[Permit System]
    E --> E2[Configurations]
    E --> E3[Reward Zone]

Ready to dive deeper? Let's explore the ERP System or learn about building addons!