Skip to content

Commit e0f8881

Browse files
MI-85: Update document
1 parent eb2d9d1 commit e0f8881

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,18 +96,19 @@ The pipe expects:
9696

9797
## Development
9898

99-
To build the image locally:
99+
1. build the image locally:
100100

101101
```bash
102-
# [Optional] Run this if we want to remove devDependencies from node_modules before building
103-
npm ci --omit=dev
104102
# Transpile our source code to Javascript
105103
npm run build
104+
# [Optional] Run this if we want to remove devDependencies from node_modules before building docker image
105+
# If we run this, we will need to re-run `npm ci` later on if we fix bug & want to build another image.
106+
npm prune --production
106107
# Build docker image
107108
docker build --build-arg="NODE_TAG=20" -t aligent/nx-pipe:20-alpine .
108109
```
109110

110-
To run the container locally and mount current local directory to the /app/work folder:
111+
2. Run the container locally and mount current local directory to the /app/work folder:
111112

112113
```bash
113114
docker run -it --memory=4g --memory-swap=4g --memory-swappiness=0 --cpus=4 --entrypoint=/bin/sh \
@@ -121,6 +122,7 @@ docker run -it --memory=4g --memory-swap=4g --memory-swappiness=0 --cpus=4 --ent
121122
-e UPLOAD_BADGE=false \
122123
-e APP_USERNAME=test-app-username \
123124
-e APP_PASSWORD=test-app-password \
125+
-e DEBUG=true \
124126
aligent/nx-pipe:20-alpine
125127
```
126128

0 commit comments

Comments
 (0)