Is gramps-web still maintained?

Yes, active. Last change today. Latest release v26.11.2, today.

Can I trust gramps-web?

Widely used. 1.8k stars, 5 years old, by an organization. As with any download, get it from the official repo.

gitmanual

Reading the repo

Opening the box…

How to install on Windows

gramps-project/gramps-web

Open Source Online Genealogy System

Node.js#family-history#family-tree#gedcom#genealogy

Difficulty: Easy
Time: about 5 min
Stars: ★ 1,814
Activity: Updated this month

Before you start

Is it free?: YesOpen source (AGPL-3.0).
Still maintained?: Yes, activeLast change today. Latest release v26.11.2, today.
Can I trust it?: Widely used1.8k stars, 5 years old, by an organization. As with any download, get it from the official repo.

Saved setup from 2 h ago

Will it work on Windows?

Yes, it runs on Windows

You'll build it yourself with Node.js.

Your system

macOS Windows Linux

Start here

Website ↗grampsweb.orgThe project's own site.In the browser ↗Open in GitHub CodespacesNothing to install.

5 steps on Windows

Download setup.ps1

Then run powershell -ExecutionPolicy Bypass -File .\setup.ps1. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.

Clone the repository

Needs Git: winget install Git.Git

git clone https://github.com/gramps-project/gramps-web.git
cd gramps-web

Install the required runtimes

Node.js 22

winget install CoreyButler.NVMforWindows
nvm install 22
nvm use 22

3
Install dependencies
```
npm ci
```
4
Run it
```
npm run start
```
5
Run the tests
```
npm test
```

Did you get it running?

No reports for Windows yet.

Still stuck? Ask an AI

Opens a chat with this manual already filled in, for Windows. It uses your own account; gitmanual sends nothing.

Ask Claude Ask ChatGPT

Parts list

1×Node.js 22runtime
1×npm package manager

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/gramps-project/gramps-web/badge.svg)](https://gitmanual.com/gramps-project/gramps-web)

Good to know

Dockerfile available (base image: dmstraub/gramps-webapi:latest).
Dev Container config found — you can open it in VS Code Dev Containers or GitHub Codespaces for a zero-setup environment.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.

Details

License: AGPL-3.0
Open issues: 68
Branch: main

package.json scripts (12)

lint:eslinteslint --ext .js,.ts . --ignore-path .gitignore
format:eslinteslint --ext .js,.ts . --fix --ignore-path .gitignore
lint:prettierprettier "**/*.{js,ts}" --check --ignore-path .gitignore
format:prettierprettier "**/*.{js,ts}" --write --ignore-path .gitignore
lintnpm run lint:eslint && npm run lint:prettier
formatnpm run format:eslint && npm run format:prettier
testvitest run --coverage
test:watchvitest
buildrimraf dist && rollup -c rollup.config.js
start:buildnpm run build && web-dev-server --root-dir dist --app-index index.html --open --compatibility none
startweb-dev-server --app-index index.html --host 0.0.0.0 --node-resolve --open --watch --port 8001
typechecktsc --noEmit

Files we read (9)

.devcontainer/devcontainer.json

.github/workflows/image-devel.yml

.github/workflows/image-release.yml

.github/workflows/release.yml

.github/workflows/test.yml

CONTRIBUTING.md

Dockerfile

README.md

package.json

572 files in the repo