Skip to content

Commit 552f2db

Browse files
committed
README updated
1 parent f6e4e2c commit 552f2db

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

README.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,60 @@
5050

5151
## Installation
5252

53-
`pip install zenml-dashboard`
53+
The installation is as follows:
54+
55+
First, there is a pre-requisite to use `npm` version 14.20.0 exactly. One can do this by installing the `nvm` (https://github.com/nvm-sh/nvm) utility and then doing
56+
57+
```
58+
nvm install 14.20.0
59+
nvm use 14.20.0
60+
```
61+
62+
Users also need to have yarn installed.
63+
64+
Then you can run it by doing:
65+
66+
```
67+
yarn install
68+
yarn start
69+
```
70+
71+
To build it:
72+
73+
```
74+
yarn build
75+
```
76+
77+
The app takes the following env variables:
78+
79+
```
80+
REACT_APP_BASE_API_URL="<YOUR_ZENML_SERVER_DEPOLOYMENT_URL>/api/v1"
81+
```
82+
83+
84+
85+
86+
## Deployment
87+
88+
We should add a section here as to how its linked to the main ZenML repository
89+
90+
Basically, each ZenML python package comes with the build files (generated by `yarn build`) of a certain version of this dashboard (all build files of the dashboard can be seen in the releases section of this github). Therefore, each ZenML pypi package has bundled in it a corresponding version of this dashboard.
91+
92+
With the python package, you can then serve these static build files by doing:
93+
94+
```
95+
zenml up
96+
```
97+
98+
Which creates a local daemon that serves the files in a FastAPI server!
99+
100+
You can also deploy this dashboard on supported cloud providers with ZenML python package by using the command:
101+
102+
```
103+
zenml deploy
104+
```
105+
106+
# :bowtie: User Experience
54107

55108
## Log In
56109

0 commit comments

Comments
 (0)