Skip to content

Commit db9caf7

Browse files
committed
Update README with git subtrees
1 parent 16bd477 commit db9caf7

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,27 @@
11
# human-connection-api-nodejs-client
22
[![Build Status](https://travis-ci.org/roschaefer/human-connection-api-nodejs-client.svg?branch=master)](https://travis-ci.org/roschaefer/human-connection-api-nodejs-client)
33

4-
Have a local Human Connection API server running on [port 3030](http:://localhost:3030), see [instructions](https://github.com/Human-Connection/API).
4+
## Prerequisites
5+
The development environment of this plugin uses the backend APIs of [Human Connection](https://human-connection.org/) and [Democracy](https://www.democracy-deutschland.de/#!start).
6+
If you clone this repository, you have a version of both backend APIs in [/democracy-server](/democracy-server) and [/human-connection-api](/human-connection-api) as [git subtrees](https://git-scm.com/book/en/v1/Git-Tools-Subtree-Merging), respectively.
7+
Follow the installation instructions of both Human Connection API and Democracy API:
8+
9+
https://github.com/demokratie-live/democracy-server
10+
https://github.com/Human-Connection/API
11+
12+
13+
## Installation
14+
15+
Install dependencies with [yarn](https://yarnpkg.com/en/):
16+
```sh
17+
yarn install
18+
```
19+
20+
## Run
521

622
Make sure you have [node](https://nodejs.org/en/) installed with a version >= 9.0.0.
723

824
Then run:
9-
1025
```sh
1126
node --experimental-modules index.mjs
1227

@@ -16,4 +31,3 @@ Or
1631
```sh
1732
yarn start
1833
```
19-
if you have yarn installed.

0 commit comments

Comments
 (0)