|
1 | | -# [Liberu Automation](https://www.liberu.org.uk)  |
2 | | - |
3 | | - |
4 | | - |
5 | | - |
6 | | - |
7 | | - |
8 | | - |
9 | | - |
10 | | -[](https://opensource.org/licenses/MIT) |
11 | | - |
12 | | -[](https://github.com/liberu-automation/automation-laravel/actions/workflows/install.yml) |
13 | | -[](https://github.com/liberu-automation/automation-laravel/actions/workflows/tests.yml) |
14 | | -[](https://github.com/liberu-automation/automation-laravel/actions/workflows/main.yml) |
| 1 | +# Liberu Automation |
15 | 2 |
|
| 3 | +[Managed web hosting for our application packages](https://liberu.co.uk) |
16 | 4 |
|
17 | | -# [Managed web hosting for our application packages](https://liberu.co.uk) |
| 5 | +[](https://www.php.net/) |
| 6 | +[](https://laravel.com/) |
| 7 | +[ |
| 8 | +[](https://laravel-livewire.com/) |
| 9 | +[](https://laravel.com/docs/socialite) |
18 | 10 |
|
| 11 | +[](https://github.com/liberu-automation/automation-laravel/actions/workflows/install.yml) |
| 12 | +[](https://github.com/liberu-automation/automation-laravel/actions/workflows/tests.yml) |
| 13 | +[](https://github.com/liberu-automation/automation-laravel/actions/workflows/main.yml) |
| 14 | +[](https://codecov.io/gh/liberu-automation/automation-laravel) |
| 15 | +[](https://opensource.org/licenses/MIT) |
19 | 16 |
|
20 | | -## Our Projects |
| 17 | +--- |
21 | 18 |
|
22 | | -* https://github.com/liberu-accounting/accounting-laravel |
23 | | -* https://github.com/liberu-automation/automation-laravel |
24 | | -* https://github.com/liberu-billing/billing-laravel |
25 | | -* https://github.com/liberusoftware/boilerplate |
26 | | -* https://github.com/liberu-browser-game/browser-game-laravel |
27 | | -* https://github.com/liberu-cms/cms-laravel |
28 | | -* https://github.com/liberu-control-panel/control-panel-laravel |
29 | | -* https://github.com/liberu-crm/crm-laravel |
30 | | -* https://github.com/liberu-ecommerce/ecommerce-laravel |
31 | | -* https://github.com/liberu-genealogy/genealogy-laravel |
32 | | -* https://github.com/liberu-maintenance/maintenance-laravel |
33 | | -* https://github.com/liberu-real-estate/real-estate-laravel |
34 | | -* https://github.com/liberu-social-network/social-network-laravel |
| 19 | +A lightweight Laravel-based control panel for automated hosting and billing workflows. Designed for maintainability and integration with Filament and Jetstream. |
35 | 20 |
|
36 | | -## Setup |
| 21 | +**Key features** |
37 | 22 |
|
38 | | -1. Ensure your environment is set up with PHP 8.3 and Composer installed. |
39 | | -2. Download the project files from this GitHub repository. |
40 | | -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. |
41 | | -4. Run the following command: |
| 23 | +- Hosting control panel primitives (user, team, account, site settings) |
| 24 | +- Billing automation hooks and seeders |
| 25 | +- Filament admin resources and Livewire components |
| 26 | +- Pluggable modules architecture |
42 | 27 |
|
43 | | -```bash |
44 | | -./setup.sh |
45 | | -``` |
| 28 | +## Quick start |
46 | 29 |
|
47 | | -and everything should be installed automatically if you are using Linux you just run the script as you normally run scripts in the terminal. |
| 30 | +1. Requirements: PHP 8.3+, Composer, Node.js (optional for assets). |
| 31 | +2. Clone the repository and install dependencies. |
48 | 32 |
|
49 | | -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). |
| 33 | +PowerShell / Bash |
50 | 34 |
|
51 | | -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. |
52 | | -```bash |
53 | | -composer install |
54 | | -php artisan key:generate |
| 35 | +```powershell |
| 36 | +# install PHP deps, generate key, migrate and seed |
| 37 | +composer install; |
| 38 | +cp .env.example .env; |
| 39 | +php artisan key:generate; |
55 | 40 | php artisan migrate --seed |
56 | 41 | ``` |
57 | | -This will install the necessary dependencies, generate an application key, and set up your database with initial data. |
58 | | - |
59 | | -NOTE 3: Ensure your `.env` file is correctly configured with your database connection details before running migrations. |
60 | | - |
61 | | -## Building with Docker |
62 | | - |
63 | | -Alternatively, you can build and run the project using Docker. To build the Dockerfile, follow these steps: |
64 | | - |
65 | | -1. Ensure you have Docker installed on your system. |
66 | | -2. Open a terminal in the project folder. |
67 | | -3. Run the following command to build the Docker image: |
68 | | - ``` |
69 | | - docker build -t automation-laravel . |
70 | | - ``` |
71 | | -4. Once the image is built, you can run the container with: |
72 | | - ``` |
73 | | - docker run -p 8000:8000 automation-laravel |
74 | | - ``` |
75 | | - |
76 | | -NOTE 3: Ensure your `.env` file is correctly configured with your database connection details before running migrations. |
77 | | - |
78 | | -### Using Laravel Sail |
79 | | - |
80 | | -This project also includes support for Laravel Sail, which provides a Docker-based development environment. To use Laravel Sail, follow these steps: |
81 | | - |
82 | | -1. Ensure you have Docker installed on your system. |
83 | | -2. Open a terminal in the project folder. |
84 | | -3. Run the following command to start the Laravel Sail environment: |
85 | | - ``` |
86 | | - ./vendor/bin/sail up |
87 | | - ``` |
88 | | -4. Once the containers are running, you can access the application at `http://localhost`. |
89 | | -5. To stop the Sail environment, press `Ctrl+C` in the terminal. |
90 | | - |
91 | | -For more information on using Laravel Sail, refer to the [official documentation](https://laravel.com/docs/sail). |
92 | 42 |
|
93 | | -### Description |
94 | | -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. |
| 43 | +Docker (build & run) |
95 | 44 |
|
96 | | -**Key Features:** |
97 | | - |
98 | | -1. **Intuitive Control Panel:** Liberu Automation boasts an intuitive and user-friendly control panel, providing seamless management of web hosting resources. From domain administration to server configuration, our project simplifies the complexities of web hosting, ensuring a smooth and accessible experience for users. |
99 | | - |
100 | | -2. **Billing Automation:** Automate your billing processes with Liberu Automation. From subscription management to invoice generation, our project facilitates effortless financial transactions, saving time and resources for both administrators and users. |
101 | | - |
102 | | -3. **Real-time Monitoring:** Keep a vigilant eye on your web hosting infrastructure with real-time monitoring features. Leveraging Laravel 11 and PHP 8.3, Liberu Automation ensures that administrators can track server performance, resource usage, and other critical metrics to maintain optimal functionality. |
103 | | - |
104 | | -4. **Client Management:** Enhance client relationships through Liberu Automation's comprehensive client management system. From user permissions to support ticket systems, our project empowers administrators to provide top-notch service to their clients. |
105 | | - |
106 | | -5. **Efficient Administration:** Filament 3, our admin panel built on Laravel, adds an extra layer of efficiency to Liberu Automation. Administrators can effortlessly manage user permissions, customize settings, and oversee the entire hosting infrastructure with a powerful and intuitive interface. |
107 | | - |
108 | | -Liberu Automation is open source, released under the permissive MIT license. We invite web hosting providers, developers, and tech enthusiasts to join us in shaping the future of hosting management tools. Together, let's harness the power of technology to simplify web hosting, automate billing processes, and create a seamless experience for administrators and users alike. |
109 | | - |
110 | | -Welcome to Liberu Automation – where innovation meets control and efficiency in the dynamic world of web hosting. Join us on this journey to redefine the standards of web hosting control panels and billing systems. |
111 | | - |
112 | | -### Licensed under MIT, use for any personal or commercial project. |
113 | | - |
114 | | -### Contributions |
115 | | - |
116 | | -We warmly welcome new contributions from the community! We believe in the power of collaboration and appreciate any involvement you'd like to have in improving our project. Whether you prefer submitting pull requests with code enhancements or raising issues to help us identify areas of improvement, we value your participation. |
| 45 | +```bash |
| 46 | +# build image and run (local, single-container) |
| 47 | +docker build -t automation-laravel .; |
| 48 | +docker run -p 8000:8000 automation-laravel |
| 49 | +``` |
117 | 50 |
|
118 | | -If you have code changes or feature enhancements to propose, pull requests are a fantastic way to share your ideas with us. We encourage you to fork the project, make the necessary modifications, and submit a pull request for our review. Our team will diligently review your changes and work together with you to ensure the highest quality outcome. |
| 51 | +Using Laravel Sail |
119 | 52 |
|
120 | | -However, we understand that not everyone is comfortable with submitting code directly. If you come across any issues or have suggestions for improvement, we greatly appreciate your input. By raising an issue, you provide valuable insights that help us identify and address potential problems or opportunities for growth. |
| 53 | +```bash |
| 54 | +# start Sail (Docker) |
| 55 | +./vendor/bin/sail up -d |
| 56 | +``` |
121 | 57 |
|
122 | | -Whether through pull requests or issues, your contributions play a vital role in making our project even better. We believe in fostering an inclusive and collaborative environment where everyone's ideas are valued and respected. |
| 58 | +## Related projects |
123 | 59 |
|
124 | | -We look forward to your involvement, and together, we can create a vibrant and thriving project. Thank you for considering contributing to our community! |
125 | | -<!--/h--> |
| 60 | +| Project | Repository | |
| 61 | +|---|---| |
| 62 | +| Accounting | [liberu-accounting/accounting-laravel](https://github.com/liberu-accounting/accounting-laravel) | |
| 63 | +| Automation (this) | [liberu-automation/automation-laravel](https://github.com/liberu-automation/automation-laravel) | |
| 64 | +| Billing | [liberu-billing/billing-laravel](https://github.com/liberu-billing/billing-laravel) | |
| 65 | +| Boilerplate | [liberusoftware/boilerplate](https://github.com/liberusoftware/boilerplate) | |
| 66 | +| Browser game | [liberu-browser-game/browser-game-laravel](https://github.com/liberu-browser-game/browser-game-laravel) | |
| 67 | +| CMS | [liberu-cms/cms-laravel](https://github.com/liberu-cms/cms-laravel) | |
| 68 | +| Control Panel | [liberu-control-panel/control-panel-laravel](https://github.com/liberu-control-panel/control-panel-laravel) | |
| 69 | +| CRM | [liberu-crm/crm-laravel](https://github.com/liberu-crm/crm-laravel) | |
| 70 | +| E-commerce | [liberu-ecommerce/ecommerce-laravel](https://github.com/liberu-ecommerce/ecommerce-laravel) | |
| 71 | +| Genealogy | [liberu-genealogy/genealogy-laravel](https://github.com/liberu-genealogy/genealogy-laravel) | |
| 72 | +| Maintenance | [liberu-maintenance/maintenance-laravel](https://github.com/liberu-maintenance/maintenance-laravel) | |
| 73 | +| Real estate | [liberu-real-estate/real-estate-laravel](https://github.com/liberu-real-estate/real-estate-laravel) | |
| 74 | +| Social network | [liberu-social-network/social-network-laravel](https://github.com/liberu-social-network/social-network-laravel) | |
126 | 75 |
|
127 | | -### License |
| 76 | +## Contributing |
128 | 77 |
|
129 | | -This project is licensed under the MIT license, granting you the freedom to utilize it for both personal and commercial projects. The MIT license ensures that you have the flexibility to adapt, modify, and distribute the project as per your needs. Feel free to incorporate it into your own ventures, whether they are personal endeavors or part of a larger commercial undertaking. The permissive nature of the MIT license empowers you to leverage this project without any unnecessary restrictions. Enjoy the benefits of this open and accessible license as you embark on your creative and entrepreneurial pursuits. |
130 | | -<!--/h--> |
| 78 | +- Please open issues for bugs or feature requests. |
| 79 | +- Contributions are welcome via pull requests. Follow PSR-12 coding style and include tests where applicable. |
131 | 80 |
|
132 | | -## Contributors |
| 81 | +## License |
133 | 82 |
|
| 83 | +This project is released under the MIT License. See the `LICENSE` file for details. |
134 | 84 |
|
135 | | -<a href = "https://github.com/liberu-automation/automation-laravel/graphs/contributors"> |
136 | | - <img src = "https://contrib.rocks/image?repo=liberu-automation/automation-laravel"/> |
| 85 | +<div align="center">Made with ♥ by Liberu</div> |
0 commit comments