huanld/speckle-server
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

chore(preview-service): update README (#4389)

Browse Source 
* chore(preview-service): update README

* Update README for docker
This commit is contained in:
Iain Sproat
2025-04-11 16:06:58 +01:00
committed by GitHub
parent 965e2d4ee6
commit fe859a075c
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/preview-service/readme.md
+12 -2
View File
@@ -30,7 +30,17 @@ Then build the service:
yarn build
```
This builds both typescript and webpack (for the page that is deployed to chromium to create the views). It should be rerun whenever you make changes to the viewer (if you make local viewer changes, don't forget to build the viewer module before running this)
We also need to build the preview-service frontend:
```bash
yarn build:frontend
```
Then, we need to copy the built artefacts from the preview-service frontend in to the preview-service (backend) directory:
```bash
yarn link:frontend
```
Finally, you can run the preview service with:
@@ -51,7 +61,7 @@ docker build -f packages/preview-service/Dockerfile -t speckle-preview-service:l
Once you have built the preview service Dockerfile, you can run it like so:
```bash
docker run --rm -p 3001:3001 -e PORT=3001 -e PG_CONNECTION_STRING=postgres://speckle:speckle@host.docker.internal/speckle speckle-preview-service:local
docker run --rm -p 3001:3001 -e PORT=3001 -e REDIS_URL=redis://redis:6379 speckle-preview-service:local
```
## Deployment notes