README

A Powerfull Package

Short Information
A modular Laravel package to manage internal users (staff, admins, developers) separately from the public user system. It comes with its own authentication, profile management, roles & permissions, and a powerful documentation system.

About Insider Pack

InsiderPack is a local Laravel package, tailor-made for the Quanta application, providing a complete and isolated ecosystem for internal user management. Instead of mixing your staff and admin logic with your public-facing users, InsiderPack segregates it into its own modular and maintainable module.

This package introduces the "Insider" system—a completely separate user entity with its own tables, models, and authentication guard. This allows you to build complex back-office features or admin panels without interfering with your application's main user flow.

Key Features

• 🔐 Separate Authentication: Its own login (api/insider/login) and registration system, using Sanctum tokens under the 'insider' guard.
• ⚙️ Database-Driven Configuration: Critical settings like registration allowance (allow_registration) and documentation access (documentation_is_public) can be changed dynamically through the database, with a fallback to the config file.
• 👤 Complete Profile Management: A comprehensive database structure for personal data, addresses, and employment details (InsiderProfile).
• 🛡️ Roles & Permissions Integration: Fully integrated with spatie/laravel-permission under the 'insider' guard for granular access control.
• 📖 Built-in Documentation System: A full-featured documentation module with versioning, categories, languages, revisions, and public/private access control.
• ⚡ Custom Code Generators: Speed up development with custom Artisan commands (insider:make-*) to generate Models, Controllers, and more directly within the package directory.
• 🚀 One-Command Installation: Simply run php artisan install:insider-pack to automatically publish assets, run migrations, and seed initial data.

Installation

This package is designed for a seamless setup process using its custom Artisan command.

1. Require the Package Add the package to your main composer.json file and update your autoloader.

   • In your root composer.json, add the repository and require the package:

     "require": {
         "aminuddin12/insider-pack": "@dev"
     },
     "repositories": [
         {
             "type": "path",
             "url": "Packages/Aminuddin12/InsiderPack"
         }
     ]

   • Run composer dump-autoload.

2. Run the Install Command Execute the following command from your project's root directory. This single command will handle everything.

   php artisan install:insider-pack

   This command will:

   • Publish the insiderpack.php configuration file.
   • Run all necessary database migrations.
   • Seed the database with default roles, permissions, and settings.
   • Clear relevant caches.

Configuration

After installation, a configuration file will be available at config/insiderpack.php.

<?php
return [
    'allow_registration' => env('INSIDER_ALLOW_REGISTRATION', false),
    'documentation_is_public' => env('DOCUMENTATION_IS_PUBLIC', true),
];