Skip to content

Commit 6aaf8e0

Browse files
Improve instructons and update packages and workflows
1 parent efbc48a commit 6aaf8e0

File tree

7 files changed

+255
-242
lines changed

7 files changed

+255
-242
lines changed

.github/workflows/main.yml

Lines changed: 0 additions & 160 deletions
This file was deleted.

README.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,82 @@
11
# Liberu Automation
2-
Control Panel and Billing System.
32

43
![](https://img.shields.io/badge/PHP-8.3-informational?style=flat&logo=php&color=4f5b93)
54
![](https://img.shields.io/badge/Laravel-11-informational?style=flat&logo=laravel&color=ef3b2d)
65
![](https://img.shields.io/badge/JavaScript-ECMA2020-informational?style=flat&logo=JavaScript&color=F7DF1E)
76
![](https://img.shields.io/badge/Livewire-3.5-informational?style=flat&logo=Livewire&color=fb70a9)
87
![](https://img.shields.io/badge/Filament-3.2-informational?style=flat&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI0OCIgaGVpZ2h0PSI0OCIgeG1sbnM6dj0iaHR0cHM6Ly92ZWN0YS5pby9uYW5vIj48cGF0aCBkPSJNMCAwaDQ4djQ4SDBWMHoiIGZpbGw9IiNmNGIyNWUiLz48cGF0aCBkPSJNMjggN2wtMSA2LTMuNDM3LjgxM0wyMCAxNWwtMSAzaDZ2NWgtN2wtMyAxOEg4Yy41MTUtNS44NTMgMS40NTQtMTEuMzMgMy0xN0g4di01bDUtMSAuMjUtMy4yNUMxNCAxMSAxNCAxMSAxNS40MzggOC41NjMgMTkuNDI5IDYuMTI4IDIzLjQ0MiA2LjY4NyAyOCA3eiIgZmlsbD0iIzI4MjQxZSIvPjxwYXRoIGQ9Ik0zMCAxOGg0YzIuMjMzIDUuMzM0IDIuMjMzIDUuMzM0IDEuMTI1IDguNUwzNCAyOWMtLjE2OCAzLjIwOS0uMTY4IDMuMjA5IDAgNmwtMiAxIDEgM2gtNXYyaC0yYy44NzUtNy42MjUuODc1LTcuNjI1IDItMTFoMnYtMmgtMnYtMmwyLTF2LTQtM3oiIGZpbGw9IiMyYTIwMTIiLz48cGF0aCBkPSJNMzUuNTYzIDYuODEzQzM4IDcgMzggNyAzOSA4Yy4xODggMi40MzguMTg4IDIuNDM4IDAgNWwtMiAyYy0yLjYyNS0uMzc1LTIuNjI1LS4zNzUtNS0xLS42MjUtMi4zNzUtLjYyNS0yLjM3NS0xLTUgMi0yIDItMiA0LjU2My0yLjE4N3oiIGZpbGw9IiM0MDM5MzEiLz48cGF0aCBkPSJNMzAgMThoNGMyLjA1NSA1LjMxOSAyLjA1NSA1LjMxOSAxLjgxMyA4LjMxM0wzNSAyOGwtMyAxdi0ybC00IDF2LTJsMi0xdi00LTN6IiBmaWxsPSIjMzEyODFlIi8+PHBhdGggZD0iTTI5IDI3aDN2MmgydjJoLTJ2MmwtNC0xdi0yaDJsLTEtM3oiIGZpbGw9IiMxNTEzMTAiLz48cGF0aCBkPSJNMzAgMThoNHYzaC0ydjJsLTMgMSAxLTZ6IiBmaWxsPSIjNjA0YjMyIi8+PC9zdmc+&&color=fdae4b&link=https://filamentphp.com)
98

9+
[![Install](https://github.com/liberu-automation/automation-laravel/actions/workflows/install.yml/badge.svg)](https://github.com/liberu-automation/automation-laravel/actions/workflows/install.yml)
10+
[![Tests](https://github.com/liberu-automation/automation-laravel/actions/workflows/tests.yml/badge.svg)](https://github.com/liberu-automation/automation-laravel/actions/workflows/tests.yml)
11+
12+
13+
1014
### Other active projects
1115
* https://github.com/liberu-accounting/accounting-laravel
16+
* https://github.com/liberu-automation/automation-laravel
1217
* https://github.com/liberu-cms/cms-laravel
1318
* https://github.com/liberu-crm/crm-laravel
1419
* https://github.com/liberu-ecommerce/ecommerce-laravel
1520
* https://github.com/liberu-maintenance/maintenance-laravel
1621
* https://github.com/liberu-real-estate/real-estate-laravel
1722

23+
## Setup
24+
25+
1. Ensure your environment is set up with PHP 8.3 and Composer installed.
26+
2. Download the project files from this GitHub repository.
27+
3. Open a terminal in the project folder. If you are on Windows and have Git Bash installed, you can use it for the following steps.
28+
4. Run the following command:
29+
30+
```bash
31+
./setup.sh
32+
```
33+
34+
and everything should be installed automatically if you are using Linux you just run the script as you normally run scripts in the terminal.
35+
36+
NOTE 1: The script will ask you if you want to have your .env be overwritten by .env.example, in case you have already an .env configuration available please answer with "n" (No).
37+
38+
NOTE 2: This script will run seeders, please make sure you are aware of this and don't run this script if you don't want this to happen.
39+
```bash
40+
composer install
41+
php artisan key:generate
42+
php artisan migrate --seed
43+
```
44+
This will install the necessary dependencies, generate an application key, and set up your database with initial data.
45+
46+
NOTE 3: Ensure your `.env` file is correctly configured with your database connection details before running migrations.
47+
48+
## Building with Docker
49+
50+
Alternatively, you can build and run the project using Docker. To build the Dockerfile, follow these steps:
51+
52+
1. Ensure you have Docker installed on your system.
53+
2. Open a terminal in the project folder.
54+
3. Run the following command to build the Docker image:
55+
```
56+
docker build -t automation-laravel .
57+
```
58+
4. Once the image is built, you can run the container with:
59+
```
60+
docker run -p 8000:8000 automation-laravel
61+
```
62+
63+
NOTE 3: Ensure your `.env` file is correctly configured with your database connection details before running migrations.
64+
65+
### Using Laravel Sail
66+
67+
This project also includes support for Laravel Sail, which provides a Docker-based development environment. To use Laravel Sail, follow these steps:
68+
69+
1. Ensure you have Docker installed on your system.
70+
2. Open a terminal in the project folder.
71+
3. Run the following command to start the Laravel Sail environment:
72+
```
73+
./vendor/bin/sail up
74+
```
75+
4. Once the containers are running, you can access the application at `http://localhost`.
76+
5. To stop the Sail environment, press `Ctrl+C` in the terminal.
77+
78+
For more information on using Laravel Sail, refer to the [official documentation](https://laravel.com/docs/sail).
79+
1880
### Description
1981
Welcome to Liberu Automation, our revolutionary open-source project that redefines the world of web hosting control and billing. With the powerful combination of Laravel 11, PHP 8.3, Livewire 3, and Filament 3, Liberu Automation is not just a control panel – it's a dynamic solution designed to streamline web hosting management and billing processes with efficiency and innovation.
2082

0 commit comments

Comments
 (0)