Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/magicsunday/webtrees-fan-chart

SVG based ancestor fan chart module for webtrees genealogy application.
https://github.com/magicsunday/webtrees-fan-chart

chart d3js fan-chart fanchart genealogy-application module svg webtrees

Last synced: 4 days ago
JSON representation

SVG based ancestor fan chart module for webtrees genealogy application.

Host: GitHub
URL: https://github.com/magicsunday/webtrees-fan-chart
Owner: magicsunday
License: gpl-3.0
Created: 2017-01-26T10:23:22.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-12-02T08:30:16.000Z (23 days ago)
Last Synced: 2024-12-15T00:32:10.769Z (11 days ago)
Topics: chart, d3js, fan-chart, fanchart, genealogy-application, module, svg, webtrees
Language: JavaScript
Homepage:
Size: 3.61 MB
Stars: 60
Watchers: 12
Forks: 19
Open Issues: 10
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        [![Latest version](https://img.shields.io/github/v/release/magicsunday/webtrees-fan-chart?sort=semver)](https://github.com/magicsunday/webtrees-fan-chart/releases/latest)

[![License](https://img.shields.io/github/license/magicsunday/webtrees-fan-chart)](https://github.com/magicsunday/webtrees-fan-chart/blob/main/LICENSE)

[![CI](https://github.com/magicsunday/webtrees-fan-chart/actions/workflows/ci.yml/badge.svg)](https://github.com/magicsunday/webtrees-fan-chart/actions/workflows/ci.yml)

* [Fan chart](#fan-chart)

  * [Installation](#installation)

    * [Manual installation](#manual-installation)

    * [Using Composer](#using-composer)

      * [Latest version](#latest-version)

    * [Using Git](#using-git)

  * [Configuration](#configuration)

  * [Usage](#usage)

  * [Development](#development)

    * [Run tests](#run-tests)

# Fan chart

This module provides an SVG ancestor fan chart for the [webtrees](https://www.webtrees.net) genealogy application.

![210 Degree chart with opened contextmenu](assets/fan-chart-210-contextmenu.png)

![210 Degree chart with color gradients and hidden empty segments](assets/fan-chart-210-gradient.png)

## Installation

Requires Webtrees 2.2.

There are several ways to install the module. The method using [composer](#using-composer) is suitable

for experienced users, as a developer you can also use [git](#using-git) to get a copy of the repository. For all other users,

however, manual installation is recommended.

### Manual installation

To manually install the module, perform the following steps:

1. Download the [latest release](https://github.com/magicsunday/webtrees-fan-chart/releases/latest) of the module.

2. Upload the downloaded file to your web server.

3. Unzip the package into your ``modules_v4`` directory.

4. Rename the folder to ``webtrees-fan-chart``

If everything was successful, you should see a subdirectory ``webtrees-fan-chart`` with the unpacked content

in the ``modules_v4`` directory.

Then follow the steps described in [configuration](#configuration) and [usage](#usage).

### Using Composer

Typically, to install with [composer](https://getcomposer.org/), run the following command from the command line,

from the root of your Webtrees installation.

```shell

composer require magicsunday/webtrees-fan-chart --update-no-dev

```

The module will automatically install into the ``modules_v4`` directory of your Webtrees installation.

To remove the module run:

```shell

composer remove magicsunday/webtrees-fan-chart --update-no-dev

```

Then follow the steps described in [configuration](#configuration) and [usage](#usage).

#### Latest version

If you are using the development version of Webtrees (main branch), you may also need to install the development

version of the module. For this, please use the following command:

```

composer require magicsunday/webtrees-fan-chart:dev-master --update-no-dev

```

### Using Git

If you are using ``git``, you could also clone the current master branch directly into your ``modules_v4`` directory

by calling:

```shell

git clone https://github.com/magicsunday/webtrees-fan-chart.git modules_v4/webtrees-fan-chart

```

Then follow the steps described in [configuration](#configuration) and [usage](#usage).

## Configuration

Go to the control panel (admin section) of your installation and scroll down to the ``Modules`` section. Click

on ``Charts`` (in subsection Genealogy). Enable the ``Fan chart`` custom module (optionally disable the original

installed fan chart module) and save your settings.

![Control panel - Module administration](assets/control-panel-modules.png)

## Usage

At the charts' menu, you will find a new link called `Fan chart`. Use the provided configuration options

to adjust the layout of the charts according to your needs.

Right-clicking on an individual opens a tooltip providing more detailed information of the current individual.

## Development

To build/update the JavaScript, run the following commands:

```shell

nvm install node

npm install

npm run prepare

```

### Run tests

```shell

composer update

composer ci:test

composer ci:test:php:phpstan

composer ci:test:php:lint

composer ci:test:php:rector

```