Skip to content

Commit 99d86f5

Browse files
committed
docs (readme): add build and deployment details
1 parent 13ca34b commit 99d86f5

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,25 @@ npm run test:unit
6868
npm run test:e2e
6969
```
7070

71+
## Building
72+
73+
To build the app for production, run:
74+
75+
```shell
76+
./compile-build.sh release.tar.gz dist
77+
```
78+
79+
This runs the npm build script and then compiles the build into a tarball, including the revision number.
80+
81+
The build executes in `production` [mode by default](https://vitejs.dev/guide/env-and-mode#modes) and includes environment variables from the `.env.production` file.
82+
Environment variables not specified in the `.env.production` file will fall back to values in the `.env` file if they exist.
83+
84+
## Deployment
85+
86+
Deployment is handled by the Deployment project, as usual, however it should be noted that context-specific environment variables undergo a string replacement process during deployment. All environment variables with the prefix `REPLACE_` are replaced with the corresponding values in the Deployment project at deployment time using GNU `awk`'s `gsub` function.
87+
88+
As of June 2024, Quanthub is hosted on the SS load balancers.
89+
7190
## Notes
7291

7392
A predefined list of printers is used for the printer selection dropdown. This list is defined in the file `src/config/printers.json`. Additional printers, such as the logging printer `stub`, can be added to this list by setting the environment variable `VITE_CUSTOM_PRINTERS` to a comma-separated list of printer names, e.g. `VITE_CUSTOM_PRINTERS=stub,printer1,printer2`.

0 commit comments

Comments
 (0)