Skip to content
This repository has been archived by the owner on Feb 4, 2024. It is now read-only.

Latest commit

 

History

History
72 lines (42 loc) · 5.81 KB

README.md

File metadata and controls

72 lines (42 loc) · 5.81 KB
Raw

Liberu Genealogy - Open Source Family Tree Software - Laravel 10 / PHP 8.2 Backend

Latest Stable Version Scrutinizer Code Quality Code Intelligence Status StyleCI CodeFactor codebeat badge CircleCI

Installation steps

  1. Begin by downloading the project using the command git clone https://github.com/laravel-liberu/genealogy.git

  2. Next, make a copy of the .env.example file and rename it as .env. Open the .env file and update the necessary details according to your specific configuration.

  3. Run the command composer install to install the project dependencies. If you are using Windows, you may need to run composer install --ignore-platform-reqs instead.

  4. Generate an application key by executing the command php artisan key:generate

  5. Launch the project by running php artisan serve.

  6. To set up the database tables and seed them with initial data, run the command php artisan migrate --seed

  7. If needed, you can customize the configuration files located in config/liberu/*.php according to your requirements.

  8. For certain configurations, you may need to set up sanctum stateful domains and session domain in the .env file. Additionally, add your domains to the config/cors.php file.

  9. Lastly, follow the installation steps for the client side by visiting the link provided: https://github.com/liberu-ui/genealogy.

  10. Launch the site and log into the project using the following credentials:

User: [email protected] Password: password

By following these steps, you will successfully download the project, configure the necessary environment variables, install dependencies, generate a key, run the project, migrate the database, customize configurations if needed, and set up the client-side application. You can then log in to the project with the specified user credentials and begin exploring its features.

Example data

  • Prior to proceeding, ensure that the command "php artisan queue:work" is running. This command is essential for the proper functioning of the queue system.

  • It is important to use the root database user for this process. Make sure you are logged in with the appropriate credentials to avoid any potential issues.

  • To begin, register a new user and then proceed to log in to the system. This step is necessary to access and utilize the full functionality of the platform.

  • Once logged in, navigate to the "gedcom/import" section. Here, you can upload the desired GEDCOM file for processing. We recommend using the following URL: https://github.com/laravel-liberu/public-gedcoms/blob/master/files/royal92.ged

  • By following these steps, you can seamlessly run the queue, ensure the correct database user is utilized, register and log in with a new user account, and successfully import the specified GEDCOM file.

Note: Please ensure that you have a stable internet connection during the process to facilitate a smooth experience.

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.