From 92e630f24f1946adaa878dbf46268194ec53032f Mon Sep 17 00:00:00 2001 From: Oliver Boehlk Date: Fri, 29 May 2020 19:37:46 +0200 Subject: [PATCH] add backend readme closes #77 --- backend/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 backend/README.md diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..2a46064 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,18 @@ +# Backend for the Simcompanies-Dashboard + +## Available Scripts + +In the project directory, you can run: + +### `yarn start` + +Runs the app in the production mode.
+Access the API and frontend files on [http://localhost:3001](http://localhost:3001) to view it in the browser. + +### `npm run debug` + +Runs the app in the developement mode.
+Access the API and frontend files on [http://localhost:3001](http://localhost:3001) to view it in the browser. +You can only login with the credentials "test" "test". + +The server reloads on changes you still need to refresh your browserpage yourself.