README

Hosted application packages

Our Projects

Setup

Ensure your environment is set up with PHP 8.3 and Composer installed.
Download the project files from this GitHub repository.
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.
Run the following command:

./setup.sh

and everything should be installed automatically if you are using Linux you just run the script as you normally run scripts in the terminal.

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).

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.

composer install
php artisan key:generate
php artisan migrate --seed

This will install the necessary dependencies, generate an application key, and set up your database with initial data.

NOTE 3: Ensure your .env file is correctly configured with your database connection details before running migrations.

Building with Docker

Alternatively, you can build and run the project using Docker. To build the Dockerfile, follow these steps:

Ensure you have Docker installed on your system.
Open a terminal in the project folder.
Run the following command to build the Docker image:
```
docker build -t maintenance-laravel .
```
Once the image is built, you can run the container with:
```
docker run -p 8000:8000 maintenance-laravel
```

NOTE 3: Ensure your .env file is correctly configured with your database connection details before running migrations.

Using Laravel Sail

This project also includes support for Laravel Sail, which provides a Docker-based development environment. To use Laravel Sail, follow these steps:

Ensure you have Docker installed on your system.
Open a terminal in the project folder.
Run the following command to start the Laravel Sail environment:
```
./vendor/bin/sail up
```
Once the containers are running, you can access the application at http://localhost.
To stop the Sail environment, press Ctrl+C in the terminal.

For more information on using Laravel Sail, refer to the official documentation.

Description

Welcome to Liberu Maintenance, our groundbreaking open-source project that reshapes the landscape of maintenance management through the integration of Laravel 11, PHP 8.3, Livewire 3, and Filament 3. Liberu Maintenance is not just a tool for tracking repairs and schedules; it's a dynamic solution designed to streamline and optimize maintenance processes, ensuring efficiency and reliability.

Key Features:

Intuitive Maintenance Tracking: Liberu Maintenance offers an intuitive interface for tracking and managing maintenance tasks. From equipment repairs to scheduled maintenance, our project simplifies the complexities of upkeep, ensuring a smooth and organized process.
Dynamic Livewire Interactions: Built on Laravel 11 and PHP 8.3, Liberu Maintenance leverages Livewire 3 to provide dynamic and real-time interactions. Update maintenance records, track progress, and communicate seamlessly with your maintenance teams without the need for page refreshes.
Efficient Admin Panel: Filament 3, our admin panel built on Laravel, provides administrators with powerful tools to manage maintenance schedules, customize settings, and oversee the entire maintenance ecosystem. Liberu Maintenance ensures that your equipment and facilities operate seamlessly, adapting to your organization's evolving needs.
Task Assignment and Notifications: Streamline task assignment and stay informed with Liberu Maintenance's task management features. Assign maintenance tasks, track their status, and receive real-time notifications, ensuring timely response to maintenance requirements.
Customizable Forms: Tailor maintenance request forms and checklists to capture specific information relevant to your industry. Liberu Maintenance empowers users to create custom forms that align with their unique maintenance processes, ensuring comprehensive data collection.

Liberu Maintenance is open source, released under the permissive MIT license. We invite facility managers, maintenance teams, and developers to contribute to the evolution of maintenance management. Together, let's redefine the standards of upkeep and create a platform that adapts to the unique needs of every user.

Welcome to Liberu Maintenance – where innovation meets reliability, and the possibilities of maintenance management are limitless. Join us on this journey to transform the way we maintain and optimize our facilities in the digital age.

Licensed under MIT, use for any personal or commercial project.

Demostration website

Contributions

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.

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.

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.

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.

We look forward to your involvement, and together, we can create a vibrant and thriving project. Thank you for considering contributing to our community!

License

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.

liberu-maintenance / maintenance-laravel

Maintainers

Details