Skip to content

fetsorn/evenor

Repository files navigation

evenor

Evenor - query and edit timelines. Tell the story of your own data.

Developer Information and Tools

Install dependencies

If you use nix, run `nix develop` to install all dependencies in PATH

You’ll need to install nodejs >= 18.15.0. We use yarn but npm should work too. Assuming that’s done, run `yarn` with no args:

yarn

Build for desktop

If you use nix, run `nix build git+https://github.com/fetsorn/evenor#all`

A desktop Electron app that stores data in a system folder.

yarn start:electron

yarn build:electron

Build for browser

If you use nix, run `nix build git+https://github.com/fetsorn/evenor#webapp`

A React webapp that stores data in browser memory.

yarn build:webapp

Build for command-line

If you use nix, run `nix run git+https://github.com/fetsorn/evenor`

A React webapp that stores data in current working directory.

## build command-line service
yarn build:server

## get a sample csvs project
## from https://github.com/fetsorn/csvs-init.git
cd ~/csvs-init

## launch command-line
node path/to/evenor/src-server/index.js

Documentation

Evenor stands for “EVENt editOR”. In Greek, Evenor is the ancestor of the people of Atlantis. In Tolkien’s Elvish, “evenor” can be loosely translated as “common ground”.

Structure of the repo

renderer - a React app, packaged both as a webapp and as an Electron renderer

src-electron - main Electron thread

server - a local ExpressJS server that serves the React app

lib - common APIs

Thanks

isomorphic-git - A pure JavaScript implementation of git for node and browsers

genea - Completely serverless solution for consuming and authoring GEDCOM genealogy data

ged2dot - GEDCOM to Graphviz converter

hpcc-js-wasm - Graphviz compiled to WASM

electron-react-boilerplate - electron-builder with TypeScript and React

@matrixai/typescript-demo-electron - electron-forge with TypeScript, Vue and Nix