README

A comprehensive Laravel package for managing organizational structures, specifically designed for any kind of government offices or organization. This package provides tools to visualize organograms, manage employee data, and streamline reporting relationships.

✨ Features

Organizational Hierarchy Management: Create and manage complex organizational structures
Visual Organogram Tree: Interactive tree visualization of organizational hierarchy
Employee Management: Comprehensive employee data management
Multi-language Support: Built-in support for Bangla and English
RESTful API: Complete API endpoints for integration with frontend applications
Database Migrations: Ready-to-use database schema
Sample Data Seeder: Pre-configured sample data for quick setup
Responsive Frontend: Beautiful, mobile-friendly interface
Laravel Integration: Seamless integration with Laravel applications

📋 Requirements

PHP 8.0 or higher
Laravel 10, 11, or 12
MySQL 5.7

🚀 Installation

1. Install via Composer

composer require sanwarul/organogram

2. Install Package (Recommended)

The package includes an installation command that will set up everything:

php artisan organogram:install

This command will:

Run migrations
Publish seeders
Seed the database with sample data
Optionally install the frontend

📖 Usage

Creating Organizations

use Sanwarul\Organogram\Models\Organization;

$ministry = Organization::create([
    'name' => 'Ministry of Public Administration',
    'code' => 'MOPA',
    'type' => 'ministry',
    'metadata' => json_encode([
                'address' => 'Bangladesh Secretariat, Dhaka',
                'phone' => '02-12345678',
                'email' => 'mopa@mopa.gov.bd'
    ]),
]);

// Add Bangla translation
$ministry->setTranslation('name', 'bn', 'জনপ্রশাসন মন্ত্রণালয়');
$ministry->save();

Creating Sub-organizations

$division = Organization::create([
    'name' => 'Public Administration Division',
    'code' => 'PAD',
    'type' => 'division',
    'parent_id' => $ministry->id,
    'metadata' => json_encode([
                'address' => 'Bangladesh Secretariat, Dhaka',
                'phone' => '02-12345678',
                'email' => 'mopa@mopa.gov.bd'
    ]),
]);

Retrieving Organizational Tree

$tree = Organization::with('children')->whereNull('parent_id')->get();

🔌 API Endpoints

The package provides the following API endpoints:

Organizations

Method	Endpoint	Description
GET	`/api/organizations`	List all organizations
POST	`/api/organizations`	Create new organization
GET	`/api/organizations/{id}`	Get organization details
PUT	`/api/organizations/{id}`	Update organization
DELETE	`/api/organizations/{id}`	Delete organization

Departments

Method	Endpoint	Description
GET	`/api/departments`	List all departments
POST	`/api/departments`	Create new departments
GET	`/api/departments/{id}`	Get departments details
PUT	`/api/departments/{id}`	Update departments
DELETE	`/api/departments/{id}`	Delete departments

Positions

Method	Endpoint	Description
GET	`/api/positions`	List all positions
POST	`/api/positions`	Create new positions
GET	`/api/positions/{id}`	Get positions details
PUT	`/api/positions/{id}`	Update positions
DELETE	`/api/positions/{id}`	Delete positions

Employees

Method	Endpoint	Description
GET	`/api/employees`	List all employees
POST	`/api/employees`	Create new employees
GET	`/api/employees/{id}`	Get employees details
PUT	`/api/employees/{id}`	Update employees
DELETE	`/api/employees/{id}`	Delete employees

Organogram

Method	Endpoint	Description
GET	`/api/organogram/{id}`	Get organization tree
GET	`/api/organogram/{id}/employees`	Get employees in organization

🗄️ Database Schema

Organizations Table

Column	Type	Description
id	bigint	Primary key
name	string	Organization name
code	string	Unique code
type	string	Organization type (ministry, division, department, office)
parent_id	bigint	Foreign key to parent organization
metadata	json	Additional information
created_at	timestamp	Creation timestamp
updated_at	timestamp	Update timestamp

Departments Table

Column	Type	Description
id	bigint	Primary key
organization_id	bigint	Foreign key to organization
name	string	Department name
code	string	Unique code
description	text	Description of the department
parent_id	bigint	Foreign key to parent department
created_at	timestamp	Creation timestamp
updated_at	timestamp	Update timestamp

Position Table

Column	Type	Description
id	bigint	Primary key
department_id	bigint	Foreign key to department
name	string	Position name
code	string	Unique code
grade	text	Grade of the department
responsibilities	text	Responsibilities
created_at	timestamp	Creation timestamp
updated_at	timestamp	Update timestamp

Employees Table

Column	Type	Description
id	bigint	Primary key
name	string	Employee name
position_id	bigint	Foreign key to position
department_id	bigint	Foreign key to department
organization_id	bigint	Foreign key to organization
email	string	Email address
phone	string	Phone number
created_at	timestamp	Creation timestamp
updated_at	timestamp	Update timestamp

📊 Sample Data Structure

The package seeds a sample organizational structure:

Ministry of Public Administration (MOPA)
└── Public Administration Division (PAD)
    └── Chief Information Commissioner Office (CICO)

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

🔒 Security

If you discover any security related issues, please email muhammad.sanwarul94@gmail.com instead of using the issue tracker.

👨‍💻 Credits

🆘 Support

If you are having general issues with the package, feel free to reach out to me:

sanwarul/organogram

包简介

README 文档