Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgeurts/genealogy
Genealogy is a free and open-source (family tree) application to record family members and their relationships, build with PHP (Laravel 11).
https://github.com/mgeurts/genealogy
ancestry common-table-expression family-tree genealogy jetstream laravel lineage livewire parentage pedigree tabler-icons tailwindcss vite
Last synced: 25 days ago
JSON representation
Genealogy is a free and open-source (family tree) application to record family members and their relationships, build with PHP (Laravel 11).
- Host: GitHub
- URL: https://github.com/mgeurts/genealogy
- Owner: MGeurts
- License: mit
- Created: 2024-01-17T21:13:35.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-13T21:33:34.000Z (7 months ago)
- Last Synced: 2024-04-14T12:01:13.217Z (7 months ago)
- Topics: ancestry, common-table-expression, family-tree, genealogy, jetstream, laravel, lineage, livewire, parentage, pedigree, tabler-icons, tailwindcss, vite
- Language: PHP
- Homepage: https://genealogy.kreaweb.be/
- Size: 12.1 MB
- Stars: 68
- Watchers: 2
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Genealogy
## About this project
Genealogy is a free and open-source family tree PHP application to record family members and their relationships, build with Laravel 11.
This TallStack application is build using :
-
Laravel 11 -
Laravel Jetstream 5 (featuring Teams) -
Livewire 3 -
Alpine.js 3 - Tailwind CSS
-
TallStackUI (featuring Tabler Icons) -
Laravel Filament 3 (only Table Builder)
### Logic concept
1. A person can have 1 biological father (1 person, based on father_id)
2. A person can have 1 biological mother (1 person, based on mother_id)
3. A person can have 1 set of parents, biological or not (1 couple of 2 people, based on parents_id)
4. A person can have 0 to many biological children (n people, based on father_id/mother_id)
5. A couple can have 0 to many (plus) children (based on parents_id as a couple or father_id/mother_id individually)
6. A person can have 0 to many partners (n people), being part of 0 to many couples (opposite or same biological sex)
7. A person can be part of a couple with the same partner multiple times (remarriage or reunite)
8. A person can have 0 to many siblings (n people) (based on parents_id as a couple or father_id/mother_id individually)
9. A couple can be married or not, still together or separated in the meantime
### Requirements
-
At least PHP 8.3, supporting Laravel 11.
-
At least MySQL 8.0.1 or MariaDB 10.2.2 or an equivalent database, supporting Recursive Common Table Expressions.
### License
This project is open-sourced software licensed under the [MIT license](LICENSE).
## Demo
This demo has 2 family trees implemented, BRITISH ROYALS and KENNEDY.
E-mail
Password
Purpose
[email protected]
password
to access teams BRITISH ROYALS and KENNEDY as team owner
[email protected]
password
to access team BRITISH ROYALS as manager
[email protected]
password
to access team KENNEDY as editor
[email protected]
password
to access team BRITISH ROYALS as normal member
[email protected]
password
to access team KENNEDY as normal member
[email protected]
password
to access options reserved for the developer, like the user management and access to all persons in all teams
## Roles & permissions
Role
Model
Permissions
Administrator
user
create, read, update, delete
person
create, read, update, delete
couple
create, read, update, delete
Manager
person
create, read, update, delete
couple
create, read, update, delete
Editor
person
create, read, update
couple
create, read, update
Member
person
read
couple
read
## Features
- Light/Dark theme
- Fully responsive
- Multi-language, English, Dutch and German are already implemented, language setting saved in authenticated users profile
- Multi-timezone, timezone setting saved in authenticated users profile
- Multi-tenancy by Laravel Jetstream Teams
- Security through Laravel Jetstream Teams Roles & Permissions, 2FA & API can be enabled
- Offcanvas menu
- Multiple image upload with possibility of watermarking, photo carousel with navigation
- Multiple documents upload
### Special features
This application has a built-in Backup Manager :
- Backups can be initiated and managed manually
- Backups can be scheludeld by issuing a cron job on your development or production server
- An e-mail will be send after each backup
This application has a built-in Log Viewer, on demand showing :
- INFO : All scheduled backups
- DEBUG : All executed database queries, but only in local development mode
- DEBUG : All executed requests
- WARNING : All detected N+1 queries, but only in local development mode
- ERROR : All detected errors
This application has a built-in User management & logging, available to the developer :
- User statistics by country of origin
- User statistics by year, month, week or day
All activities (create, update, delete) on persons and couples are logged in the database.
Change history available on Persons.
### To Do ...
-
GEDCOM import and export.
## Techniques
Both the ancestors and descendants family trees are build using Recursive Common Table Expressions (Recursive CTE). This prevents the N+1 query problem generating the recursive tree family elements and dramatically improves performance.
## Installation
create a new project folder, cd into the folder
`git clone https://github.com/MGeurts/genealogy.git .`
`cp .env.example .env`
make the needed changes regarding name, url, database connection & mail server
`composer install`
`php artisan key:generate`
`php artisan storage:link`
`php artisan migrate:fresh --seed`
`npm install & npm run build`
`php artisan serve` or `npm run dev`
## Testing
`php artisan test`
## Contributing
Feel free to submit Issues or Pull Requests, for bugs, suggestions or feature requests.
## Documentation
The documentation is included in the applications help.
Visit the demo project to read the documentation.
### Sponsoring
If you like this project, please consider giving it a star and spread the word. Thank you.
## Impressum
### Basic idea (2017)
This application is based on an original idea by Nafies Luthfi. Thanks for your excellent work.
### Design & Development (2024)
This Laravel application is designed and developed by kreaweb.be.