Installation

General Install Instructions

The repository can be found on GitHub. https://github.com/Human-Connection/Human-Connection

TODO: Create documentation section for How to Start and Beginners.

Here are some general informations about our GitHub Standard Fork & Pull Request Workflow.

Fork the Repository

Click on the fork button.

Fork screenshot

Clone your new Repository

Set the current working folder to the path in which the repository should be cloned (copied).

$ cd PATH-FOR-REPO

For cloning your new repository to your local machine modify the following command to add your GitHub user name.

HTTPS

$ git clone https://github.com/YOUR-GITHUB-USERNAME/Human-Connection.git

SSH

$ git clone [e-mail]:YOUR-GITHUB-USERNAME/Human-Connection.git

Change into the new folder.

$ cd Human-Connection

Add the original Human Connection repository as upstream. This prepares you to synchronize your local clone with a simple pull command in the future.

HTTPS

$ git remote add upstream https://github.com/Human-Connection/Human-Connection.git

SSH

$ git remote add upstream [e-mail]:Human-Connection/Human-Connection.git

Docker Installation

Docker is a software development container tool that combines software and its dependencies into one standardized unit that contains everything needed to run it. This helps us to avoid problems with dependencies and makes installation easier.

General Installation of Docker

There are sevaral ways to install Docker CE on your computer or server.

Docker Desktop macOS

Follow these instructions to install Docker Desktop on macOS.

Docker Desktop Windows

Follow these instructions to install Docker Desktop on Windows.

Docker CE

Follow these instructions to install Docker CE.

This is a great option for Linux users.

Check the correct Docker installation by checking the version before proceeding. E.g. we have the following versions:

$ docker --version
Docker version 18.09.2
$ docker-compose --version
docker-compose version 1.23.2

Install Nitro with Docker

Run the following command to install Nitro as a Docker container. This installation includes Neo4j.

The installation takes a bit longer on the first pass or on rebuild ...

$ docker-compose up

# rebuild the containers for a cleanup
$ docker-compose up --build

Seed Neo4j in Docker

To seed the Neo4j database with default data, that GraphQL requests or playing with our GraphQL Playground returns anything else than an empty response, run the command.

Run the following command to seed the Neo4j database with default data requested by Nitro-Web through GraphQL or when you play with our GraphQL playground.

# open another terminal

# create indices etc.
$ docker-compose exec neo4j migrate

# seed database
$ docker-compose exec backend yarn run db:seed

Wipe out Neo4j database in Docker

To wipe out your neo4j database and delete the volumes send command:

# open another terminal and run
$ docker-compose down -v

Video Tutorial

TODO: Link to video

Development with Kubernetes

For further informations see also our Kubernetes documentation.

Local Installation

Install the dependencies

$ yarn install
$ cd backend && yarn install
$ cd ../webapp && yarn install
$ cd ..

Copy Environment Variables

$ cp cypress.env.template.json cypress.env.json
$ cp backend/.env.template backend/.env
$ cp webapp/.env.template webapp/.env

Configure the new files according to your needs and your local setup.