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

feat: separate prettier from eslint

Browse Source
This commit is contained in:
Rainer Killinger
2023-01-11 13:25:18 +01:00
committed by Thea Schöbl
parent 939fb6ef0f
commit a88d000ccd
381 changed files with 17952 additions and 38411 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -16,21 +16,25 @@ There are (`npm`) scripts defined to get the app running as quickly as possible.
```
npm run docker:pull
```
which pulls the up-to-date image ([Dockerfile](Dockerfile)) which contains all the tools needed for building, serving and deploying the app.
```
npm run docker:enter
```
which enters the container on docker builder image, where we can run `npm install` (to install the required npm packages) and `npm build` (to build the app: convert into executable files), but also any other arbitrary commands with the tools available in the docker image.
```
npm run docker:build
```
which runs `npm install` (to install the required npm packages) and `npm build` (to build the app: convert into executable files) in the docker container which runs on the docker builder image.
```
npm run docker:serve
```
which serves the app for running it in the browser. It basically runs `ionic serve` in the docker container (in the docker builder image).
## How to build and start the app using the default backend?
@@ -39,6 +43,7 @@ which serves the app for running it in the browser. It basically runs `ionic ser
npm run build
npm run start
```
will build and serve the app using the configuration for a default backend.
## Further explanation of npm scripts
@@ -74,6 +79,7 @@ npm run build
```
Open the app in the browser:
```
ionic serve
```
@@ -109,15 +115,19 @@ npm run docker:build:android
The mentioned `docker:*:android` npm commands are executed in a docker container, so it is not mandatory to have the android (command line) tools installed on the host computer. Alternatively, you can install the tools and additionally Android Studio on the host machine and then run and build the app on the host (without using docker).
### Executing tests
Execute unit tests:
```
npm test
```
Execute e2e tests:
```
npm run e2e
```
As mentioned, we can always check the [package.json](package.json) for details on each npm script/command.
## Using Gitlab CI as a reference