Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-07 05:52:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: fix and adjust the README file

Browse Source
This commit is contained in:
Jovan Krunić
2020-11-26 10:10:58 +01:00
parent bba0964fae
commit 072204b748
1 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -16,7 +16,7 @@ There are (`npm`) scripts defined to get the app running as quickly as possible.
``` ```
npm run docker:fresh 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 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 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? ## How to build and start the app using the default backend?
```
npm run build:web
npm run serve:web
```
Will build and serve the app using the configuration for the fake-backend.
``` ```
npm run build npm run build
npm run serve npm run start
npm run build:prod
npm run serve:prod
``` ```
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. 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.