@zenuml/core 3.14.5 → 3.14.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -2
- package/dist/zenuml.esm.mjs +1 -1
- package/dist/zenuml.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,9 +23,37 @@ Please follow the [integration guide](./docs/asciidoc/integration-guide.adoc) fo
|
|
|
23
23
|
|
|
24
24
|
# Development
|
|
25
25
|
|
|
26
|
+
## Technical Requirements
|
|
27
|
+
|
|
28
|
+
These are the tools we use for working with the code and documentation:
|
|
29
|
+
|
|
30
|
+
- [volta](https://volta.sh/) to manage node versions.
|
|
31
|
+
- [Node.js](https://nodejs.org/en/). `volta install node`
|
|
32
|
+
- [pnpm](https://pnpm.io/) package manager. `volta install pnpm`
|
|
33
|
+
- [npx](https://docs.npmjs.com/cli/v8/commands/npx) the packaged executor in npm. This is needed [to install pnpm.](#install-packages)
|
|
34
|
+
|
|
35
|
+
Follow the setup steps below to install them and start the development.
|
|
36
|
+
|
|
37
|
+
### Switch to project
|
|
38
|
+
|
|
39
|
+
Once you have cloned the repository onto your development machine, change into the `zenuml-core` project folder (the top level directory of the @zenuml/core project repository)
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
cd zenuml-core
|
|
26
43
|
```
|
|
27
|
-
|
|
28
|
-
|
|
44
|
+
|
|
45
|
+
### Install packages
|
|
46
|
+
|
|
47
|
+
Run `npx pnpm install`. You will need `npx` for this because volta doesn't support it yet.
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npx pnpm install # npx is required for first install
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Launch
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npx pnpm run dev
|
|
29
57
|
```
|
|
30
58
|
|
|
31
59
|
## CI/CD
|