ocelot-Social-Community/Ocelot-Social
1
0
Fork 0
mirror of https://github.com/Ocelot-Social-Community/Ocelot-Social.git synced 2025-12-13 07:46:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
Ocelot-Social/documentation/backend/installation/README.md
Robert Schäfer a31fc5066e Merging documentation to master
2019-04-04 00:40:07 +02:00

1.7 KiB
Raw Blame History

Backend Installation

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

{% hint style="info" %} TODO: Create documentation section for How to Start and Beginners. {% endhint %}

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 backend repository should be cloned copied.

$ cd PATH-FOR-NITRO-BACKEND

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

{% tabs %} {% tab title="HTTPS" %}

$ git clone https://github.com/YOUR-GITHUB-USERNAME/Nitro-Backend.git

{% endtab %}

{% tab title="SSH" %}

$ git clone git@github.com:YOUR-GITHUB-USERNAME/Nitro-Backend.git

{% endtab %} {% endtabs %}

Change into the new folder.

$ cd Nitro-Backend

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" %}

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

{% endtab %}

{% tab title="SSH" %}

$ git remote add upstream git@github.com:Human-Connection/Nitro-Backend.git

{% endtab %} {% endtabs %}

Copy Environment Variables

$ cp .env.template .env

Configure the file .env according to your needs and your local setup.