From 0af713f65f15a081f8880aa61c175a2ed79b4033 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wolfgang=20Hu=C3=9F?= Date: Tue, 5 Jan 2021 14:47:19 +0100 Subject: [PATCH] Correct backend Readme.md --- backend/README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/backend/README.md b/backend/README.md index 66226d4ae..c09fcc25d 100644 --- a/backend/README.md +++ b/backend/README.md @@ -26,27 +26,32 @@ some known problems with more recent node versions). You can use the between different local node versions. Install node dependencies with [yarn](https://yarnpkg.com/en/): + ```bash $ cd backend $ yarn install ``` Copy Environment Variables: + ```bash # in backend/ $ cp .env.template .env ``` + Configure the new file according to your needs and your local setup. Make sure a [local Neo4J](http://localhost:7474) instance is up and running. Start the backend for development with: + ```bash $ yarn run dev ``` or start the backend in production environment with: + ```bash -yarn run start +$ yarn run start ``` For e-mail delivery, please configure at least `SMTP_HOST` and `SMTP_PORT` in @@ -65,21 +70,23 @@ backend is running: {% tabs %} {% tab title="Docker" %} -```bash -docker-compose exec backend yarn run db:migrate init -``` -{% endtab %} +```bash +$ docker-compose exec backend yarn run db:migrate init +``` + +{% endtab %} {% tab title="Without Docker" %} + ```bash # in folder backend/ # make sure your database is running on http://localhost:7474/browser/ yarn run db:migrate init ``` + {% endtab %} {% endtabs %} - #### Seed Database If you want your backend to return anything else than an empty response, you