From 5eac433f8b38a67fed5e48aa86c7fa2e635d2aeb Mon Sep 17 00:00:00 2001 From: Gang Li Date: Fri, 5 Jan 2024 14:44:45 +0800 Subject: [PATCH] Update README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index d58d2f6..fea36ea 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 \ No newline at end of file