Code Monkey home page Code Monkey logo

familyviewer's Introduction

Family Viewer

Try the Live demo

Family viewer is a client-side, JavaScript application for viewing family trees in your web browser. It takes (most) any file in GEDCOM format and displays it in a visually-pleasing, interactive manner in (most) any, reasonably modern web browser.

Basic usage

  • Drag to scroll
  • Click on an individual to change focus
  • Details about the individual (events, citations, notes, picture) are displayed in their detail window
  • Type a name into the search field to locate an individual by name
  • Click the + and - buttons to change font size
  • Navigate with keyboard (arrow keys to select immediate relatives, number keys to select a spouse)
  • The presence of hidden relatives is indicated with green rows; click to reveal them

Other features

  • Works on desktop and mobile (phone and tablets).
  • View pictures attached to individuals. (The script to generate data for this feature is not ready yet.)
  • View a "narrative," a chronological family timeline for an ancestor and all their descendants. (The script to generate data for this feature is not ready yet.)
  • Supports very large trees. You can break the tree into chunks of arbitrary size which will be downloaded on-demand.
  • Birthday calendar. Click on Help and then Birthdays to show a convenient list of everyone's birthday.
  • Also includes a Python GEDCOM parsing library.

Getting started

Run this to generate the requisite json files in the data/ directory:

cd familyviewer/util
./make-data.py --gedcom path/to/your/family.ged --note --citations

The optional --note and --citations flags tell the script to include any NOTE fields and reference transcriptions contained in your GEDCOM. If you include these flags and the relevant data is present, then the given individuals will have a "Citations" and "Note" tab in their detail window.

If your tree is very large, and you want to speed up load time of the page, use the --partition-details flag to split the detail data into multiple files, which will be downloaded by the client on demand. Note that for now, only detail data (events, notes, citations) is split.

Author

The author of this project is jepst.

License

This program is released under the GPL.

familyviewer's People

Contributors

jepst avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.