This repository has been archived by the owner on Feb 4, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
67be516
commit a2e1453
Showing
1 changed file
with
45 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| ## Genealogy - Open Source Family Tree Software - Laravel 10 backend | ||
| ## Liberu Genealogy - Open Source Family Tree Software - Laravel 10 / PHP 8.2 Backend | ||
|  | ||
| [](https://scrutinizer-ci.com/g/laravel-liberu/genealogy/?branch=master) | ||
| [](https://scrutinizer-ci.com/code-intelligence) | ||
|
|
@@ -29,66 +29,77 @@ To get started install the backend located at https://github.com/laravel-liberu/ | |
|
|
||
| Download our software today and embark on an enriching journey of tracing your roots and discovering the stories that connect generations. | ||
| <!--/h--> | ||
| ## Demo | ||
| https://www.familytree365.com - register a free account, and try the demo with no charge or obligation. | ||
| <!--/h--> | ||
|
|
||
| ### Installation Steps | ||
| ## Demostration website | ||
| Visit our demonstration website at https://www.familytree365.com to get a firsthand experience of our platform. By registering a free account, you can enjoy a no-cost and obligation-free demo. | ||
|
|
||
| Our demo provides you with the opportunity to explore the features and functionalities of our platform in a risk-free environment. Sign up and immerse yourself in the world of family trees without any financial commitment. | ||
|
|
||
| 1. Download the project with `git clone https://github.com/laravel-liberu/genealogy.git` | ||
| During the demo, you can test various aspects of our platform, including creating and editing family trees, adding family members, exploring genealogical records, and discovering the intuitive interface designed to enhance your genealogy research experience. | ||
|
|
||
| 2. Copy .env.example to .env and edit details | ||
| Take advantage of this opportunity to see how our platform can assist you in preserving your family's heritage and connecting generations. | ||
|
|
||
| 3. `composer install` or on Windows you need to use `composer install --ignore-platform-reqs` | ||
| Register now for a free account and enjoy the demo with no charges or obligations. Visit https://www.familytree365.com and begin your genealogical journey today! | ||
| <!--/h--> | ||
|
|
||
| 4. `php artisan key:generate` | ||
| ### Installation steps | ||
|
|
||
| 5. `php artisan serve` | ||
| 1. Begin by downloading the project using the command `git clone https://github.com/laravel-liberu/genealogy.git` | ||
|
|
||
| 6. Run `php artisan migrate --seed` | ||
| 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. | ||
|
|
||
| 7. (optional) Setup the configuration files as needed, in `config/enso/*.php` | ||
| 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. | ||
|
|
||
| 8. (maybe required) Setup sanctum stateful domains and session domain in `.env` and add your domains to `config/cors.php` | ||
| 4. Generate an application key by executing the command `php artisan key:generate` | ||
|
|
||
| 9. Follow installation steps for client side (https://github.com/liberu-ui/genealogy) and launch the site and log into the project with user: `[email protected]`, password: `password` | ||
| 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` | ||
|
|
||
| <!--/h--> | ||
| ## Import test data | ||
| 7. If needed, you can customize the configuration files located in config/enso/*.php according to your requirements. | ||
|
|
||
| 1. Make sure php artisan queue:work is running | ||
| 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. | ||
|
|
||
| 2. Make sure root database user is being used. | ||
| 9. Lastly, follow the installation steps for the client side by visiting the link provided: https://github.com/liberu-ui/genealogy. | ||
|
|
||
| 3. Register a new user and login. | ||
| 10. Launch the site and log into the project using the following credentials: | ||
|
|
||
| 4. Go to gedcom / import and upload https://github.com/cgdsoftware/public-gedcoms/blob/master/files/royal92.ged | ||
| 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. | ||
|
|
||
| <!--/h--> | ||
| ## Broadcasting Setup | ||
| ## Import 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. | ||
|
|
||
| ```bash | ||
| # install dependencies | ||
| $ npm install -g laravel-echo-server | ||
| * 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. | ||
|
|
||
| $ laravel-echo-server configure | ||
| $ nano .env | ||
| * 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. | ||
|
|
||
| BROADCAST_DRIVER=redis | ||
| REDIS_PREFIX= | ||
| * 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 | ||
|
|
||
| $ laravel-echo-server start | ||
| ``` | ||
| * 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. | ||
|
|
||
| If you want to keep it in background process you should install supervisor. | ||
| Note: Please ensure that you have a stable internet connection during the process to facilitate a smooth experience. | ||
|
|
||
| <!--/h--> | ||
|
|
||
| <!--h--> | ||
| ### Contributions | ||
|
|
||
| New contributions are welcome! Pull requests are great, but issues are good too. | ||
| 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 | ||
|
|
||
| Licensed under MIT, use for any personal or commercial project. | ||
| 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. | ||
| <!--/h--> | ||