Skip to content

Commit a195b01

Browse files
committed
Update Readme
1 parent cad93ab commit a195b01

File tree

2 files changed

+14
-21
lines changed

2 files changed

+14
-21
lines changed

README.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,33 @@
11
# Gramps.js
22

3-
A single-page frontend for the <a href="https://gramps-project.org">Gramps</a> Genealogical Research system.
3+
Gramps.js is a responsive frontend for the <a href="https://github.com/gramps-project/gramps-webapi/">Gramps Web API</a>. Together, they provide a modern web app that allows to browse and collaboratively edit a genealogical database created with the <a href="https://gramps-project.org">Gramps</a> desktop application.
44

5-
## About
5+
## Screenshot
66

7-
This is a Javascript web app to browse a Gramps genealogy database that is powered by the <a href="https://github.com/gramps-project/gramps-webapi">Gramps Web API</a>. The app is based on <a href="https://open-wc.org/">Open Web Components</a> and <a href="https://lit-element.polymer-project.org/">LitElement</a>.
7+
![](screenshot.png)
88

9-
(Its ancestor is the <a href="https://github.com/DavidMStraub/gramps-webapp-frontend">frontend</a> of the legacy <a href="https://github.com/DavidMStraub/gramps-webapp">Gramps web app</a>.)
109

1110
## Demo
1211

1312
A demo deployment based on the Gramps example family tree is available at https://grampsjs-demo.herokuapp.com.
1413

14+
15+
## Deployment
16+
17+
The compiled Gramps.js is a static frontend that can be easily used with an existing Gramps Web API instance. For details how to deploy the Web API, see the [Gramps Web API docs](https://gramps-project.github.io/gramps-webapi/).
18+
19+
1520
## Development setup
1621

17-
Install Node.js with [`nvm`](https://www.google.com/search?channel=fs&client=ubuntu&q=nvm):
22+
The app is based on <a href="https://open-wc.org/">Open Web Components</a> and <a href="https://lit.dev/">Lit</a>.
23+
24+
To get started with development, install Node.js with [`nvm`](https://www.google.com/search?channel=fs&client=ubuntu&q=nvm):
1825

1926
```
2027
nvm install 15.1.0
2128
```
2229

23-
Clone the repository and, at its root run
30+
Clone the repository and, at its root, run
2431
```
2532
npm install
2633
```
@@ -30,28 +37,14 @@ A backend can be started with
3037
```
3138
python -m gramps_webapi --config path/to/config run --port 5555
3239
```
33-
(for details see https://github.com/gramps-project/gramps-webapi).
40+
(for details see https://gramps-project.github.io/gramps-webapi/).
3441

3542
You can now run the frontend with
3643
```
3744
npm run start
3845
```
39-
Storybook (to view individual web components with needing to run a backend) is invoked with
40-
```
41-
npm run storybook
42-
```
4346

4447
To build the frontend for deployment, run
4548
```
4649
npm run build
4750
```
48-
49-
## Deployment
50-
51-
To deploy this app, you need a running [Gramps Web API instance](https://github.com/gramps-project/gramps-webapi).
52-
53-
There are two options for running the app:
54-
55-
- Put the distribution (downloaded from a release or built following the above instrutions) on the server running the API and point the API's `STATIC_PATH` config option to the directory containing the distribution
56-
57-
- Change the `__APIHOST__` variable in the frontend distribution to the base URL of your API instance, build the frontend and host it on a separate web server. For this to work, it requires CORS to be enabled in the API.

screenshot.png

173 KB
Loading

0 commit comments

Comments
 (0)