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.
Clone your new Repository
Set the current working folder to the path in which the repository should be cloned (copied).
For cloning your new repository to your local machine modify the following command to add your GitHub user name.
Change into the new folder.
Add the original Human Connection repository as upstream
. This prepares you to synchronize your local clone with a simple pull command in the future.
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.
Follow these instructions to install Docker Desktop on macOS.
Check the correct Docker installation by checking the version before proceeding. E.g. we have the following versions:
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 ...
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.
Wipe out Neo4j database in Docker
To wipe out your neo4j database and delete the volumes send command:
Video Tutorial
TODO: Link to video
Development with Kubernetes
For further informations see also our Kubernetes documentation.
Local Installation
Install the dependencies
Copy Environment Variables
Configure the new files according to your needs and your local setup.
Last updated