Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmrashed/laravel-installer
A complete web installer for Laravel applications, making the setup process simple and user-friendly.
https://github.com/jmrashed/laravel-installer
installer laravel laravel-installation laravel-package laravel-setup web-installer
Last synced: 16 days ago
JSON representation
A complete web installer for Laravel applications, making the setup process simple and user-friendly.
- Host: GitHub
- URL: https://github.com/jmrashed/laravel-installer
- Owner: jmrashed
- License: mit
- Created: 2024-10-18T05:03:57.000Z (28 days ago)
- Default Branch: main
- Last Pushed: 2024-10-18T08:08:58.000Z (28 days ago)
- Last Synced: 2024-10-18T08:24:32.139Z (28 days ago)
- Topics: installer, laravel, laravel-installation, laravel-package, laravel-setup, web-installer
- Language: PHP
- Homepage:
- Size: 1.43 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Installer
[](https://packagist.org/packages/jmrashed/laravel-installer) [](https://packagist.org/packages/jmrashed/laravel-installer) [](https://packagist.org/packages/jmrashed/laravel-installer) [](https://packagist.org/packages/jmrashed/laravel-installer) [](https://github.com/jmrashed/laravel-installer) [](https://github.com/jmrashed/laravel-installer)
**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:
```bash
composer require jmrashed/laravel-installer
```
Then, publish the configuration file:
```bash
php artisan vendor:publish --tag=installer-config
```
---
## 🚀 How to Use
After installation, run the installer using:
```bash
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:
```text
- 📁 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:
```php
if (!$this->validatePurchaseCode($code)) {
throw new Exception('Invalid purchase code.');
}
```
---
## 📷 Screenshots
| **Welcome Screen** | **Database Setup** | **Purchase Code Validation** |
|----------------------------|------------------------------|------------------------------|
|  |  |  |
---
## 🔧 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](LICENSE.md).
---
## 📬 Support
For support, feel free to open an issue on the [GitHub repository](https://github.com/jmrashed/laravel-installer/issues) or contact us directly.
### Click the Image Below for Documentation
[](DOCUMENTATION.md)