Arbor

A small, local-first family tree editor with GEDCOM & JSON import/export.

---

Table of Contents

• Arbor
  • Table of Contents
  • About
  • Project Structure
  • Built With
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
  • Data & Scripts
  • Development
  • Contributing
  • Authors & Contributors
  • License

---

About

Arbor is a lightweight family tree editor built with Vite, React and TypeScript. It supports importing GEDCOM and JSON files, visualizing a simple tree, editing person nodes, and exporting the tree back to GEDCOM or JSON.

Project Structure

• src/ — React application source: components, store, types, and utilities.
• data/ — sample GEDCOM files (e.g. data/complex_2000.ged).
• public/ — static assets (favicon, images).
• scripts/ — small helper scripts (GEDCOM generation: generate_gedcom.js, generate_gedcom.cjs).
• package.json, vite.config.ts, tsconfig.*.json — project configuration.

Built With

• Vite
• React
• TypeScript
• TailwindCSS (utility styles)

Getting Started

Prerequisites

• Node.js 18+ and npm or yarn

Installation

Install dependencies:

npm install

Start the development server:

npm run dev

Build for production:

npm run build

Preview the production build:

npm run preview

Usage

• Use the header (top-right controls) to import or export data.
• Supported import file types: .json, .ged, .gedcom.
• Export options: JSON or GEDCOM from the current tree.
• Example sample GEDCOM: data/complex_2000.ged.

Data & Scripts

• Sample GEDCOM files live in data/.
• Use the scripts in scripts/ to generate sample GEDCOM files:

node scripts/generate_gedcom.js
# or
node scripts/generate_gedcom.cjs

Development

• The app uses useTreeStore (Zustand) for state and utils/gedcomHandler.ts / utils/jsonHandler.ts for import/export.
• Internationalization is handled via react-i18next — toggle language from the header.

Contributing

Contributions are welcome. Please open issues for bugs or feature requests and submit small, focused pull requests. When adding features, update this README as needed and include sample data if appropriate.

Authors & Contributors

Original author: Arnaud BEUX

For a full list of contributors see the repository contributor list.

License

MIT