# Genealogy
[](https://www.paypal.me/MGeurtsKREAWEB)
[](https://buymeacoffee.com/MGeurts)
## About this project
Genealogy is a free and open-source family tree PHP application to record family members and their relationships, build with 13.
This TallStack application is build using :
### 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
### License
This project is open-sourced software licensed under the [MIT license](LICENSE).
## Demo
https://genealogy.kreaweb.be/
This demo has 2 family trees implemented, BRITISH ROYALS and KENNEDY.
| E-mail |
Password |
Purpose |
| administrator@genealogy.test |
password |
to access teams BRITISH ROYALS and KENNEDY as team owner |
| manager@genealogy.test |
password |
to access team BRITISH ROYALS as manager |
| editor@genealogy.test |
password |
to access team KENNEDY as editor |
| member_1@genealogy.test |
password |
to access team BRITISH ROYALS as normal member |
| member_4@genealogy.test |
password |
to access team KENNEDY as normal member |
| developer@genealogy.test |
password |
to access options reserved for the developer, like the user management and access to all persons in all teams |
## Roles & permissions
### Teams & Users
| Role |
Model |
Permissions |
| Team owner |
personal team |
update, invite members |
| non-personal team |
read, update, delete, invite members, transfer ownership |
| new team |
create |
| Team member |
personal team |
update, invite members |
| non-personal team |
accept membership, read, leave |
| new team |
create |
### Persons & Couples
| Role |
Model |
Permissions |
| Administrator |
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, language setting saved in authenticated users profile
- Multi-timezone, timezone setting saved in authenticated users profile
- Multi-tenancy by Laravel Jetstream Teams, including Transfer Team Ownership
- 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
- Event management & timeline overview
### 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 requests (off by default)
- DEBUG : All executed database queries (off by default)
- WARNING : All detected slow (> 500 ms) queries
- WARNING : All detected N+1 queries
- ERROR : All detected errors
Logging can be enabled or disabled by the developer in Offcanvas Menu Settings.
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
The following activities are logged in the database:
- create, update, delete on persons (including Metadata) and couples
- create, update, delete on teams
- create, update, delete, invite, remove on users (Team members)
Activity loggings are available in Offcanvas Menu :
- Persons (with Couples) in People logbook
- Teams (with Users) in Team logbook
This application has a built-in Password Generator to help users build secure passwords.
### GEDCOM Import and Export
At present, GEDCOM Import and Export functionality is under active development.
While still incomplete, initial Import and Export capabilities are already available.
The implementation of full GEDCOM (v7.x.x) Import and Export support represents a significantly larger effort than the development of the application itself.
To date, version 7 has not been fully implemented in any open-source php based project.
**It is strongly recommended to create a backup of your database before testing any Import or Export features on production data.**
## Languages
- German (DE)
- English (EN)
- Spanish (ES)
- French (FR)
- Hindi (HI)
- Indonesian (ID)
- Dutch (NL)
- Portuguese (PT)
- Turkish (TR)
- Vietnamese (VI)
- Simplified Chinese (ZH_CN)
Translations can be added by submitting a Pull Request to the project.
Translation integrity can be checked by issuing the command:
```bash
php artisan translations:check --excludedDirectories=vendor
```
Instructions on how to add a language can be found in README-LANGUAGES.md
The application does **not support Right To Left (RTL) languages** like Arabic, Hebrew, Persian, Urdu, Pashto, Kurdish (Sorani), Uyghur, Syriac, Thaana, North Korean.
## Uploads
Instructions on how to configure file and image uploads can be found in README-UPLOADS.md.
## 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
```bash
git clone https://github.com/MGeurts/genealogy.git .
```
```bash
cp .env.example .env
```
make the needed changes regarding name, url, database connection & mail server
```bash
composer install
```
```bash
php artisan key:generate
```
```bash
php artisan storage:link
```
```bash
php artisan migrate:fresh --seed
```
```bash
npm install && npm run build
```
```bash
php artisan serve
```
or
```bash
npm run dev
```
## Updating
Update instructions can be found in README-UPDATE.md.
## Reporting security issues
Instructions on how to report security issues can be found in SECURITY.md.
## Testing
Testing is done using Pest.
Command:
```bash
php artisan test
```
or
```bash
./vendor/bin/pest
```
Production (or local development) data should be stored in a MySQL or MariaDB database configured in `.env`.
Testing data should be stored in a separate MySQL or MariaDB database configured in `.env.testing` to avoid interfering with the production or development data.
Command to create the testing MySQL database:
```bash
php artisan migrate --env=testing
```
## Contributing
Feel free to submit Issues or Pull Requests, for bugs, suggestions or feature requests.
## Docker Support
The application can be run in a Dockerized environment. Instructions can be found in README-DOCKER.md.
## Documentation
The documentation is included in the applications help.
Visit the demo project to read the documentation.
## 💖 Support This Project
Maintaining this project takes time and effort. If you find it useful, consider supporting me:
- [](https://github.com/MGeurts/genealogy)
- [](https://www.paypal.me/MGeurtsKREAWEB)
- [](https://buymeacoffee.com/MGeurts)
> Your support helps me improve and maintain [Genealogy](https://github.com/MGeurts/genealogy) and other open-source tools. Every bit is appreciated. Thank you! 🙏
## Impressum
### Design & Development (2024)
This Laravel application is designed and developed by kreaweb.be.