Backend Installation
Clone Repository
The Backend Repository can be found on github.
https://github.com/Human-Connection/Nitro-Backend
Fork the repo
Click on the fork button.
After you have forked and before you clone, create a folder on your computer to where the Nitro-Backend folders and files of your fork will be cloned (copied). In your terminal or commandline tool make this folder the actual path.
For cloning 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 %}
Copy Environment Variables
$ cp .env.template .env
Configure the file .env according to your needs and your local setup.
Installation and Usage with Docker
{% hint style="info" %} TODO: How to install Docker for Human Connection … (Also maybe there should be a main docker installation guide for the whole system at once!?) {% endhint %}
For further informations see also our Docker documentation.
Local Installation
Make sure that you have a recent version of yarn or npm installed before you proceed. E.g. we have the following versions:
$ yarn --version
1.12.3
$ npm --version
6.4.1
If the yarn or npm command is unknown you may use the docker installation (see above) or contact the developer team at Discord if you have any questions:
Install Dependencies
{% tabs %} {% tab title="Yarn" %}
$ yarn install
{% endtab %}
{% tab title="NPM" %}
$ npm install
{% endtab %} {% endtabs %}
Start the Server
{% tabs %} {% tab title="Yarn" %}
Development
$ yarn run dev
Production
# you will need to build the app first (done while building the docker image)
$ yarn run build
# run after build (dist folder must exist)
$ yarn run start
{% endtab %}
{% tab title="NPM" %}
Development
$ npm run dev
Production
# you will need to build the app first (done while building the docker image)
$ npm run build
# run after build (dist folder must exist)
$ npm run start
{% endtab %} {% endtabs %}
This will start the GraphQL service by default on [http://localhost:4000](http://localhost:4000) where you can issue GraphQL requests or access GraphQL Playground in the browser.
{% hint style="warning" %} But before you can issue GraphQL requests or access GraphQL Playground you have to install, start and seed your Neo4j database. See next step … {% endhint %}