ocelot-Social-Community/Ocelot-Social
1
0
Fork 0
mirror of https://github.com/Ocelot-Social-Community/Ocelot-Social.git synced 2025-12-12 23:35:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tell our contributors to ask for write permissions

Browse Source
This commit is contained in:
Robert Schäfer 2019-04-14 13:52:17 +02:00
parent 3edfa42f1a
commit 1be334cef6
3 changed files with 8 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/screenshot-forking-nitro-backend.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 160 KiB

BIN
.gitbook/assets/screenshot-forking-nitro.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 36 KiB

47
installation.md
View File

@ -8,34 +8,23 @@ The repository can be found on GitHub. [https://github.com/Human-Connection/Huma
TODO: Create documentation section for How to Start and Beginners.
{% endhint %}
Here are some general informations about our [GitHub Standard Fork & Pull Request Workflow](https://gist.github.com/Chaser324/ce0505fbed06b947d962).
We give write permissions to every developer who asks for it. Just text us on
[Discord](https://discord.gg/6ub73U3).
#### Fork the Repository
#### Clone the Repository
Click on the fork button.
![Fork screenshot](.gitbook/assets/screenshot-forking-nitro.png)
#### Clone your new Repository
Set the current working folder to the path in which the repository should be cloned \(copied\).
```bash
$ cd PATH-FOR-REPO
```
For cloning your new repository to your local machine modify the following command to add your GitHub user name.
Clone the repository, this will create a new folder called `Human-Connection`:
{% tabs %}
{% tab title="HTTPS" %}
```bash
$ git clone https://github.com/YOUR-GITHUB-USERNAME/Human-Connection.git
$ git clone https://github.com/Human-Connection/Human-Connection.git
```
{% endtab %}
{% tab title="SSH" %}
```bash
$ git clone git@github.com:YOUR-GITHUB-USERNAME/Human-Connection.git
$ git clone git@github.com:Human-Connection/Human-Connection.git
```
{% endtab %}
{% endtabs %}
@ -46,22 +35,6 @@ 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.
{% tabs %}
{% tab title="HTTPS" %}
```bash
$ git remote add upstream https://github.com/Human-Connection/Human-Connection.git
```
{% endtab %}
{% tab title="SSH" %}
```bash
$ git remote add upstream git@github.com:Human-Connection/Human-Connection.git
```
{% endtab %}
{% endtabs %}
## 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.
@ -95,7 +68,7 @@ $ docker-compose --version
docker-compose version 1.23.2
```
### Install Nitro with Docker
### Installation with Docker
Run the following command to install Nitro as a Docker container. This installation includes Neo4j.
@ -108,7 +81,7 @@ $ docker-compose up
$ docker-compose up --build
```
#### Seed Neo4j in Docker
#### Seed Database
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.
@ -139,10 +112,6 @@ $ docker-compose down -v
TODO: Link to video
{% endhint %}
#### Development with Kubernetes
For further informations see also our [Kubernetes documentation](https://github.com/Human-Connection/Human-Connection/tree/9bede1913b829a5c2916fc206c1fe4c83c49a4bc/kubernetes.md).
## Local Installation
#### Install the dependencies