Gramps.js

A single-page frontend for the Gramps Genealogical Research system.

About

This is a Javascript web app to browse a Gramps genealogy database that is powered by the Gramps REST API. The app is based on Open Web Components and LitElement.

Its ancestor is the frontend of the legacy Gramps web app.

Project status

The project is in early development and is not yet ready for use in production.

Contributions are welcome, but please open an issue before starting to work on a feature to avoid duplicate work.

Feature requests are premature :)

Development setup

Install Node.js with nvm:

nvm install 15.1.0

Clone the repository and, at its root run

npm install

to install dependencies.

A backend can be started with

python -m gramps_webapi --config path/to/config run --port 5555

(for details see https://github.com/gramps-project/web-api).

You can now run the frontend with

npm run start

Storybook (to view individual web components with needing to run a backend) is invoked with

npm run storybook