Menu

Guest ...

Help

Designed & developed
by KREAWEB

Help

Help


1. Concept: Models & relationships

a. People

  • A person can have 1 biological father (1 person, based on father_id)
  • A person can have 1 biological mother (1 person, based on mother_id)
  • A person can have 1 set of parents, biological or not (1 couple of 2 people, based on parents_id)
  • A person can have 0 to many biological children (n people, based on father_id/mother_id)
  • A person can have 0 to many partners (n people), being part of 0 to many couples (opposite or same biological sex)
  • A person can be part of a couple with the same partner multiple times (remarriage or reunite)

b. Couples

  • A couple can have 0 to many children (based on parents_id as a couple or father_id/mother_id individually)
  • A couple can be married or not, still together or separated in the meantime

2. Authentification, multi-tenancy and data accessibility

a. Users

Menu

Users can register themselves.
At least a surname, a valid e-mail address, a language, a timezone and a password are required.

Register

After registration and optional e-mail verification, users can login.

Login

Authenticated users, without invitation, by default belong to (and own) their own personal team.
New users, after accepting an invitation by email from another user and registering, by default will be logged in to the team they were invited to. Those users by default also have their own personal team at their disposal.

Team

b. User account and profile

Authenticated users can manage their account and user profile by using the dropdown menu in the top right-hand corner of the menu bar.

Profile settings User profile

c. Teams

This application uses Laravel Jetstream 4 with the Teams option to implement and enforce multi-tenancy.

Authenticated users can manage their teams and teams settings by using the dropdown menu in the top right-hand corner of the menu bar.

Team settings

Users can manage either their personal team or create new teams.
The personal team and all teams created by a user are also owned by that user.
Only the owner can invite other (new or already registered) users (by e-mail) to join the owned teams
.

Team management

Authenticated users can only see people and couples:

  • created by the teams they own
  • created by the teams they were invited to by the team owner as administrator, manager or editor

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

3. Search

Menu

After login and selecting the proper team, click on the Search button in the top navigation menu.

Search

Enter a search value in the search box. You can use the character % as a wildcard character.
Above the search box the number of people available to / found in the current team are shown.
You can use the pagination buttons. You can also change the number of people shown per page.

The results are shown below the search box, each person is represented in one card.

Menu

Click on the Profile or Family chart button to see details about that person.
Click on the father's or mother's name to visit the parent.


3. Adding people

After login and selecting the proper team, click on the Search button in the top navigation menu.

Search

You can add new person by clicking the Add person button above the search bar.

Add person Add person

You can also upload the primary photo for the new person.

Another way to add people is to click on the Add child tab in the Children context menu of an existing person.

Children Add child

4. Persons and relationships

a. Profile

The personal overview shows all information about the selected person.

Person overview

The navigation bar on top allows you to chose some specific items.

Person menu

The Profile card shows all general information about the person.

Profile deceased

Notice this card shows different data for living and deceased people.

Profile living

You can edit the profile, contact and death data by choosing the corresponding tab in the context menu.

Profile edit Profile edit profile Profile edit contact Profile edit death

b. Photos

Photo editing

You can browse through the available photos by using the navigation bar above the photo carousel.
You can manage photos by choosing the corresponding tab in the context menu.

Photo add

You can upload (multiple) new images.
You can download or delete existing images.
After deleting the primary photo, the first image in the collection wil become the new primary photo.
You can also set the primary image by clicking the 1 button.

c. Family

The Family card shows the person's parents and the current partner.

Family

Father and Mother are always referring to the biological father and mother.
Non-biological parent can be defined by the Parents link.

You can edit the family data by clicking the blue Edit button in the card header.

Family edit

d. Partners (Couples)

Partners

You can add, edit or delete a relationship by choosing the corresponding tab in the context menu.

Partners add Partners edit

e. Children

Children

You can add a child or disconnect existing children by choosing the corresponding tab in the context menu. The disconnected child will remain in the database as a person but just not have the selected person as father or mother anymore.

Child add

When adding a child you can either create a brand new person or select an existing person.

f. Siblings

Siblings are shown on the siblings card.

Siblings

A sibling can be full: both the same biological parents as the selected person.
A sibling can be half: only the biological mother or the biological father are common.
A sibling can be plus: neither the biological father nor the biological mother are common, but the child is part of the current relationship of the selected person

g. Ancestors

This shows the selected person's ancestors.
You can change the tree depth by using the control in the Ancestors card header.

Ancestors

h. Descendants

This shows the selected person's descendants.
You can change the tree depth by using the control in the Descendants card header.

Descendants

i. Family chart

This shows the compleet family chart, 3 generations deep.
Click on a family member name to see that person's details.

Family chart

5. Birthdays

After login and selecting the proper team, click on the Birthdays button in the top navigation menu.

Menu

This shows the upcomming birthdays.

Birthdays

6. Offcanvas menu

Users can click a button in the top right-hand menu to open the offcanvas menu.
On top the users role and permissions in the current team are shown.
If a user has the proper rights, additional features are presented.

Offcanvas menu

a. Teams & people

Teams People

b. Users & logging

The offcanvas menu allows developers to consult the users and their logging information.

Users User logging 1 User logging 2

c. Backups

The Backups menu item allows developers to manage database backups.

Backups

d. Log viewer

The Log Viewer menu item allows developers to consult the application log files.

Log viewer

e. Dependencies

The Dependencies menu item allows developers to consult the application dependencies.

Dependencies

f. Session

The Session menu item allows developers to consult the application session.

Session

7. Language & Timezone

a. Visitors

Visitor can change the language in the top right-hand menu by using the language selector.
De default application language is English.

Language menu

b. Authenticated users

Authenticated users can change the language and the timezone in the top right-hand menu by using the profile editor.
The selected language and timezone are saved in the database for further use.

Profile editor

8. Color theme

Users can change the color theme in the top right-hand menu by using the theme selector.

Theme selector