Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ligangty committed Jan 5, 2024
1 parent c02c88b commit 5eac433
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Indy UI
## Prerequisite for debugging in local
1. docker 20+
2. docker-compose 1.20+
3. (Optional) Node 18+
4. (Optional) NPM 9+
5. (Optional) Visual Studio Code

## Configure

Expand All @@ -28,3 +31,12 @@ $ mvn clean compile
```
$ mvn quarkus:dev
```

## Start to develop with node and npm

All frontend code is hosted in [src/main/webui](src/main/webui), so you can go into this folder and then use all npm command you are familiar. BTW, there are pre-defined npm script as following:
* `npm run build`: build the whole frontend application
* `npm run build-dev`: build the whole frontend application in development mode
* `npm run test`: run unit test
* `npm run server`: build the whole frontend application and start the local mock server with the built bundle. This is used to do local development with a mock REST server for all indy backend services. You can add any mock REST APIs for the frontend code consuming to do debug without to connect to real Indy backend services.
* `npm run lint`: do lint for all frontend code

0 comments on commit 5eac433

Please sign in to comment.