jmrashed/laravel-installer

A complete web installer for Laravel applications, making the setup process simple and user-friendly.

1.0.2 2024-10-18 08:07 UTC

Requires

• php: >=7.0.0

Suggests

• jmrashed/laravel-core-application-service: To extend functionality with core application services.

MIT

• Rashed Zaman

• installer
• laravel
• Web installer
• laravel package
• laravel setup
• laravel installation

README

Laravel Installer is a complete package designed to simplify the installation process for Laravel projects. This installer handles system requirement checks, environment configuration, database setup, and purchase code validation.

📊 Statistics

• Total Downloads:
• Monthly Downloads:
• GitHub Stars:
• GitHub Forks:

🌟 Features

• System Requirements Check: Automatically verifies PHP version and required extensions.
• Environment File Setup: Helps create and configure the .env file.
• Database Configuration: Offers the option to run migrations, seeders, or import an SQL dump.
• Purchase Code Validation: Built-in validation for purchase codes.
• User-Friendly Interface: A guided step-by-step installation process with a simple interface.

🛠️ Installation

To install the package, run the following command:

composer require jmrashed/laravel-installer

Then, publish the configuration file:

php artisan vendor:publish --tag=installer-config

🚀 How to Use

After installation, run the installer using:

php artisan installer:run

The installer will guide you through these steps:

1. System Requirements Check: Ensures the necessary PHP version and extensions are installed.
2. Environment File Setup: Prompts for database credentials and generates the .env file.
3. Database Setup: Choose to run migrations and seeders or import a SQL dump.
4. Purchase Code Validation: If enabled, the user is required to enter their purchase code.
5. Completion: Confirms successful installation.

📂 Directory Structure

Here’s a simplified structure of the project directories and key files:

- 📁 src/
   - 📁 Config/
      - 📄 installer.php
   - 📁 Controllers/
      - 📄 DatabaseController.php
      - 📄 EnvironmentController.php
   - 📁 Events/
      - 📄 EnvironmentSaved.php
      - 📄 LaravelInstallerFinished.php
   - 📁 Helpers/
      - 📄 DatabaseManager.php
      - 📄 EnvironmentManager.php
   - 📁 Middleware/
      - 📄 canInstall.php
      - 📄 canUpdate.php
   - 📁 Providers/
      - 📄 LaravelInstallerServiceProvider.php
   - 📁 Routes/
      - 📄 web.php
   - 📁 Views/
      - 📁 layouts/
         - 📄 master-update.blade.php
         - 📄 master.blade.php
      - 📁 update/
         - 📄 finished.blade.php
         - 📄 overview.blade.php
      - 📄 environment-classic.blade.php
      - 📄 environment-wizard.blade.php
   - 📁 assets/
      - 📁 css/
         - 📄 style.css
         - 📄 style.css.map
      - 📁 fonts/
         - 📄 FontAwesome.otf
         - 📄 fontawesome-webfont.eot
      - 📁 img/
         - 📁 favicon/
            - 📄 favicon-16x16.png
            - 📄 favicon-32x32.png
         - 📄 background.png
         - 📄 pattern.png
- 📄 LICENSE
- 📄 README.md

⚙️ Configuration

The published configuration file can be found at:

config/installer.php

This allows you to customize checks and paths, such as setting the SQL dump path for import during installation.

📥 Purchase Code Validation

If your system requires purchase code validation, you can customize the validation logic in the validatePurchaseCode function. Here’s an example:

if (!$this->validatePurchaseCode($code)) {
    throw new Exception('Invalid purchase code.');
}

📷 Screenshots

🔧 System Requirements

To ensure the Laravel Installer works as expected, your environment must meet the following requirements:

• PHP: 8.0 or higher
• Laravel: 9.0 or higher
• PHP Extensions:
  • mbstring
  • openssl
  • pdo
  • tokenizer
  • xml
  • ctype
  • json

🤝 Contributing

Contributions are welcome! If you want to contribute:

1. Fork the repository.
2. Create a new feature branch: git checkout -b feature-branch.
3. Commit your changes: git commit -m 'Add new feature'.
4. Push to the branch: git push origin feature-branch.
5. Open a pull request on GitHub.

📝 License

This package is licensed under the MIT license.

📬 Support

For support, feel free to open an issue on the GitHub repository or contact us directly.

Click the Image Below for Documentation