From 072204b7483b27eccaecfbe69b81c675b40e8d19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jovan=20Kruni=C4=87?= Date: Thu, 26 Nov 2020 10:10:58 +0100 Subject: [PATCH] docs: fix and adjust the README file --- README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 21a576c4..fbf8d9de 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ There are (`npm`) scripts defined to get the app running as quickly as possible. ``` npm run docker:fresh ``` -which pulls the fresh image ([Dockerfile](Dockerfile)) wich contains all the tools needed for building, serving and deploying the app. +which pulls the fresh image ([Dockerfile](Dockerfile)) which contains all the tools needed for building, serving and deploying the app. ``` npm run docker:enter @@ -31,26 +31,25 @@ which runs `npm install` (to install the required npm packages) and `npm build` ``` npm run docker:serve ``` -which serves the app for running it in browser. It basically runs `ionic serve` in the docker container (on the docker builder image). +which serves the app for running it in the browser. It basically runs `ionic serve` in the docker container (on the docker builder image). -## How to toggle between the backends? - -``` -npm run build:web -npm run serve:web -``` - -Will build and serve the app using the configuration for the fake-backend. +## How to build and start the app using the default backend? ``` npm run build -npm run serve -npm run build:prod -npm run serve:prod +npm run start ``` -Will build and serve the app using the configuration for a real backend. +will build and serve the app using the configuration for a default backend. -## Further explaination of npm scripts +## How to use the fake backend? + +``` +npm run start:fake +``` + +will build and serve the app using the configuration for the fake-backend (interesting in development with fake backend using HTTP interceptors). + +## Further explanation of npm scripts All the npm scripts are defined in `package.json` [file](package.json). It is recommended to open the file and check what these scripts exactly do.