IT4Change/Ocelot-Social
3
0
Fork 0
mirror of https://github.com/IT4Change/Ocelot-Social.git synced 2025-12-13 07:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Wolfgang Huß 2019-01-21 16:14:52 +01:00 committed by GitHub
parent 1dc3aaf73c
commit 03a136fc38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
backend/installation/README.md
View File

@ -1,8 +1,5 @@
# Backend Installation # Backend Installation
{% hint style="warning" %}
This documentation should be split into a **local** and a **docker** installation variant. Also maybe there should be a main docker installation guide for the whole system at once!?
{% endhint %}
### Clone Repository ### Clone Repository
@ -20,12 +17,12 @@ After you have forked, modify the following command to add your Github user name
{% tabs %} {% tabs %}
{% tab title="HTTPS" %} {% tab title="HTTPS" %}
```bash ```bash
git clone https://github.com/YOUR-GITHUB-USERNAME/Nitro-Backend.git $ git clone https://github.com/YOUR-GITHUB-USERNAME/Nitro-Backend.git
``` ```
{% endtab %} {% endtab %}
{% tab title="SSH" %} {% tab title="SSH" %}
```bash ```bash
git clone git@github.com:YOUR-GITHUB-USERNAME/Nitro-Backend.git $ git clone git@github.com:YOUR-GITHUB-USERNAME/Nitro-Backend.git
``` ```
{% endtab %} {% endtab %}
{% endtabs %} {% endtabs %}
@ -33,29 +30,45 @@ git clone git@github.com:YOUR-GITHUB-USERNAME/Nitro-Backend.git
### Copy Environment Variables ### Copy Environment Variables
```bash ```bash
cp .env.template .env $ cp .env.template .env
``` ```
Configure the file `.env` according to your needs and your local setup. Configure the file `.env` according to your needs and your local setup.
## Installation and Usage with Docker ## Installation and Usage with Docker
XXX {% 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 %}
## Local Installation ## Local Installation
Make sure that you have a recent version of [yarn](https://yarnpkg.com/en/) or [npm](https://www.npmjs.com) installed before you proceed. E.g. we have the following version:
```sh
$ yarn --version
1.12.3
$ npm --version
6.4.1
```
If the `yarn` or `npm` command is unknown you may use the [docker installation](#installation-and-usage-with-docker) (see above) or contact the developer team at [Discord](https://discord.gg/6ub73U3) if you have any questions:
### Install Dependencies ### Install Dependencies
{% tabs %} {% tabs %}
{% tab title="Yarn" %} {% tab title="Yarn" %}
```bash ```bash
yarn install $ yarn install
``` ```
{% endtab %} {% endtab %}
{% tab title="NPM" %} {% tab title="NPM" %}
```bash ```bash
npm install $ npm install
``` ```
{% endtab %} {% endtab %}
{% endtabs %} {% endtabs %}
@ -67,16 +80,16 @@ npm install
#### Development #### Development
```bash ```bash
yarn run dev $ yarn run dev
``` ```
#### Production #### Production
```bash ```bash
# you will need to build the app first (done while building the docker image) # you will need to build the app first (done while building the docker image)
yarn run build $ yarn run build
# run after build (dist folder must exist) # run after build (dist folder must exist)
yarn run start $ yarn run start
``` ```
{% endtab %} {% endtab %}
@ -84,19 +97,22 @@ yarn run start
#### Development #### Development
```bash ```bash
npm run dev $ npm run dev
``` ```
#### Production #### Production
```bash ```bash
# you will need to build the app first (done while building the docker image) # you will need to build the app first (done while building the docker image)
npm run build $ npm run build
# run after build (dist folder must exist) # run after build (dist folder must exist)
npm run start $ npm run start
``` ```
{% endtab %} {% endtab %}
{% endtabs %} {% 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 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 and start your Neo4j database. See next step …
{% endhint %}