Installation

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

We give write permissions to every developer who asks for it. Just text us on Discord.

Clone the Repository

Clone the repository, this will create a new folder called Human-Connection:

HTTPS
SSH
$ git clone https://github.com/Human-Connection/Human-Connection.git
$ git clone git@github.com:Human-Connection/Human-Connection.git

Change into the new folder.

$ cd Human-Connection

Directory Layout

There are four important directories:

  • Backend runs on the server and is a middleware between database and frontend

  • Frontend is a server-side-rendered and client-side-rendered web frontend

  • Deployment configuration for kubernetes

  • Cypress contains end-to-end tests and executable feature specifications

In order to setup the application and start to develop features you have to setup frontend and backend.

There are two approaches:

  1. Local installation, which means you have to take care of dependencies yourself

  2. Or Install everything through docker which takes care of dependencies for you

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
Docker Desktop Windows
Docker CE

Follow these instructions to install Docker Desktop on macOS.

Follow these instructions to install Docker Desktop on Windows.

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