Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/magicsunday/webtrees-statistics

SVG based statistics module for webtrees genealogy application.
https://github.com/magicsunday/webtrees-statistics

Last synced: 24 days ago
JSON representation

SVG based statistics module for webtrees genealogy application.

Host: GitHub
URL: https://github.com/magicsunday/webtrees-statistics
Owner: magicsunday
License: gpl-3.0
Created: 2023-12-14T09:52:14.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-11-29T16:54:46.000Z (26 days ago)
Last Synced: 2024-11-29T17:36:19.971Z (26 days ago)
Language: PHP
Homepage:
Size: 48.8 KB
Stars: 5
Watchers: 2
Forks: 0
Open Issues: 0
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-statistics?sort=semver)](https://github.com/magicsunday/webtrees-statistics/releases/latest)

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

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

# !!! WIP !!!

* [Statistics](#statistics)

  * [Installation](#installation)

    * [Using Composer](#using-composer)

    * [Using Git](#using-git)

  * [Development](#development)

    * [Run tests](#run-tests)

# Statistics

This modules provides SVG based statistics for the [webtrees](https://www.webtrees.net) genealogy application.

## Installation

Requires webtrees 2.2.

### Using Composer

To install using [composer](https://getcomposer.org/), just run the following command from the command line

at the root directory of your webtrees installation.

```shell

composer require magicsunday/webtrees-statistics:* --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-statistics --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-statistics.git modules_v4/webtrees-statistics

```

## 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

```