You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A single-page frontend for the <ahref="https://gramps-project.org">Gramps</a> Genealogical Research system.
3
+
Gramps.js is a responsive frontend for the <ahref="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 <ahref="https://gramps-project.org">Gramps</a> desktop application.
4
4
5
-
## About
5
+
## Screenshot
6
6
7
-
This is a Javascript web app to browse a Gramps genealogy database that is powered by the <ahref="https://github.com/gramps-project/gramps-webapi">Gramps Web API</a>. The app is based on <ahref="https://open-wc.org/">Open Web Components</a> and <ahref="https://lit-element.polymer-project.org/">LitElement</a>.
7
+

8
8
9
-
(Its ancestor is the <ahref="https://github.com/DavidMStraub/gramps-webapp-frontend">frontend</a> of the legacy <ahref="https://github.com/DavidMStraub/gramps-webapp">Gramps web app</a>.)
10
9
11
10
## Demo
12
11
13
12
A demo deployment based on the Gramps example family tree is available at https://grampsjs-demo.herokuapp.com.
14
13
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
+
15
20
## Development setup
16
21
17
-
Install Node.js with [`nvm`](https://www.google.com/search?channel=fs&client=ubuntu&q=nvm):
22
+
The app is based on <ahref="https://open-wc.org/">Open Web Components</a> and <ahref="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):
18
25
19
26
```
20
27
nvm install 15.1.0
21
28
```
22
29
23
-
Clone the repository and, at its root run
30
+
Clone the repository and, at its root, run
24
31
```
25
32
npm install
26
33
```
@@ -30,28 +37,14 @@ A backend can be started with
30
37
```
31
38
python -m gramps_webapi --config path/to/config run --port 5555
32
39
```
33
-
(for details see https://github.com/gramps-project/gramps-webapi).
40
+
(for details see https://gramps-project.github.io/gramps-webapi/).
34
41
35
42
You can now run the frontend with
36
43
```
37
44
npm run start
38
45
```
39
-
Storybook (to view individual web components with needing to run a backend) is invoked with
40
-
```
41
-
npm run storybook
42
-
```
43
46
44
47
To build the frontend for deployment, run
45
48
```
46
49
npm run build
47
50
```
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.
0 commit comments