diff --git a/backend/installation/README.md b/backend/installation/README.md index f8f7f92c7..4099352f5 100644 --- a/backend/installation/README.md +++ b/backend/installation/README.md @@ -1,8 +1,5 @@ # 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 @@ -20,12 +17,12 @@ After you have forked, modify the following command to add your Github user name {% tabs %} {% tab title="HTTPS" %} ```bash -git clone https://github.com/YOUR-GITHUB-USERNAME/Nitro-Backend.git +$ git clone https://github.com/YOUR-GITHUB-USERNAME/Nitro-Backend.git ``` {% endtab %} {% tab title="SSH" %} ```bash -git clone git@github.com:YOUR-GITHUB-USERNAME/Nitro-Backend.git +$ git clone git@github.com:YOUR-GITHUB-USERNAME/Nitro-Backend.git ``` {% endtab %} {% endtabs %} @@ -33,29 +30,45 @@ git clone git@github.com:YOUR-GITHUB-USERNAME/Nitro-Backend.git ### Copy Environment Variables ```bash -cp .env.template .env +$ cp .env.template .env ``` Configure the file `.env` according to your needs and your local setup. + ## 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 +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 {% tabs %} {% tab title="Yarn" %} ```bash -yarn install +$ yarn install ``` {% endtab %} {% tab title="NPM" %} ```bash -npm install +$ npm install ``` {% endtab %} {% endtabs %} @@ -67,16 +80,16 @@ npm install #### Development ```bash -yarn run dev +$ yarn run dev ``` #### Production ```bash # 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) -yarn run start +$ yarn run start ``` {% endtab %} @@ -84,19 +97,22 @@ yarn run start #### Development ```bash -npm run dev +$ npm run dev ``` #### Production ```bash # 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) -npm run start +$ 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 +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 %}