Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PeWu/topola-viewer
Topola Genealogy Viewer – interactive genealogy visualization
https://github.com/PeWu/topola-viewer
family-tree gedcom genealogy visualization
Last synced: about 1 month ago
JSON representation
Topola Genealogy Viewer – interactive genealogy visualization
- Host: GitHub
- URL: https://github.com/PeWu/topola-viewer
- Owner: PeWu
- License: apache-2.0
- Created: 2019-01-23T23:04:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T17:08:15.000Z (9 months ago)
- Last Synced: 2024-08-04T04:05:37.637Z (5 months ago)
- Topics: family-tree, gedcom, genealogy, visualization
- Language: TypeScript
- Homepage: https://pewu.github.io/topola-viewer
- Size: 45.3 MB
- Stars: 200
- Watchers: 17
- Forks: 49
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-gedcom - topola-viewer - interactive genealogy visualization (Visualization / TypeScript)
README
# Topola Genealogy Viewer
[](https://github.com/PeWu/topola-viewer/actions/workflows/node.js.yml)
View your genealogy data using an interactive chart.
Website: https://pewu.github.io/topola-viewer
## Features
* Hourglass chart
* All relatives chart
* Click on a person to focus
* Open standard GEDCOM files you can export from any genealogy application
* Load from URL (just point to a GEDCOM file on the Web)
* Privacy – your files do not leave your computer
* Print the whole genealogy tree
* Export to PDF, PNG, SVG
* Side panel with details
* Configuration options
* Permalinks when loading from URL
* Cool transition animations
[Changelog](CHANGELOG.md)
## Examples
Here is an example from the Web:
* [J. F. Kennedy](https://pewu.github.io/topola-viewer/#/view?url=https%3A%2F%2Fchronoplexsoftware.com%2Fmyfamilytree%2Fsamples%2FThe%2520Kennedy%2520Family.gdz) (from [https://chronoplexsoftware.com/myfamilytree/samples/](chronoplexsoftware.com))
* [Shakespeare](https://pewu.github.io/topola-viewer/#/view?url=https%3A%2F%2Fwebtreeprint.com%2Ftp_downloader.php%3Fpath%3Dfamous_gedcoms%2Fshakespeare.ged%26file%3Dshakespeare.ged) (from [webtreeprint.com](https://webtreeprint.com/tp_famous_gedcoms.php))
* [Maria Skłodowska-Curie](https://pewu.github.io/topola-viewer/#/view?indi=Sk%C5%82odowska-2&source=wikitree) (from [WikiTree](https://www.wikitree.com/wiki/Sk%C5%82odowska-2))
If you have data in a genealogy database, you can export your data in GEDCOM format and load it using the "Load from file" menu.
## Integrations
Topola Genealogy Viewer is being integrated into more and more Web and desktop applications.
Here are the current integrations:
### Gramps
To view your [Gramps](https://gramps-project.org/) data in Topola Genealogy Viewer,
install [*Interactive Family Tree*](https://gramps-project.org/wiki/index.php/Interactive_Family_Tree)
plugin from the Gramps plugin manager. The plugin will add a
*Tools->Analysis and Exploration->Interactive Family Tree* menu item to Gramps.
Source code: https://github.com/gramps-project/addons-source/tree/master/Topola
### Webtrees
Embed Topola Genealogy Viewer in your [Webtrees](https://www.webtrees.net/) installation with the
[Topola interactive tree addon](https://webtrees.net/download/modules#simple-auto-login---by-fanningert---20---website).
Source code: https://github.com/PeWu/topola-webtrees
### WikiTree
You can browse the [WikiTree](https://www.wikitree.com/) genealogy tree using Topola Genealogy Viewer.
On a WikiTree profile page go to the *Family Tree & Tools* tab and click the *Dynamic Tree by Topola* link.
Example:
[Stephen Hawking](https://apps.wikitree.com/apps/wiech13/topola-viewer/#/view?source=wikitree&standalone=false&indi=Hawking-7)
Topola Genealogy Viewer is hosted on [apps.wikitree.com](https://apps.wikitree.com/apps/wiech13/topola-viewer)
to benefit from the ability of being logged in to the WikiTree API.
## Running locally
```
npm install
npm start
```
## Self-hosting
You can host Topola Genealogy Viewer on your own server. There are no specific requirements for the hosting server. There is no code that is executed on the server side. The server only hosts the application files and whole application runs in the browser.
You can build Topola Genealogy Viewer from source code or take a ready-to-deploy package.
### Bulid your own
Here are the commands to build the application:
```
git clone https://github.com/PeWu/topola-viewer.git
cd topola-viewer
npm install
npm run build
```
Now, take the contents of the `build/` folder and host it on your own server.
### Use an existing package
Download the following file, unpack it and upload the contents to your server:
https://github.com/PeWu/topola-viewer/archive/refs/heads/gh-pages.zip
These are the exact files that are hosted on GitHub pages.
### Build for your own data only
You can run Topola Viewer in a "single tree mode" that displays only the GEDCOM you specify. Specify the URL to a GEDCOM file in the `REACT_APP_STATIC_URL` environment variable when building and running the application.
Run locally with the specified data URL:
```
REACT_APP_STATIC_URL=https://example.org/sample.ged npm start
```
Build with the specified data URL:
```
REACT_APP_STATIC_URL=https://example.org/sample.ged npm run build
```
The `build/` folder will contain files that can be hosted on a Web server.
### Alternative build
The [topola-webpack](https://github.com/develancer/topola-webpack) tool can build a Topola Genealogy Viewer package bundled together with a GEDCOM file.
## Additional options
### `handleCors`
Add `&handleCors=false` to the URL to avoid using the CORS proxy
### `embedded`
Add `&embedded=true` to the URL. This option removes the options to open a different file. It is an option that was intended to be used when Topola Genealogy Viewer is in an iframe.