You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-13Lines changed: 14 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,13 +74,14 @@
74
74
75
75
<br />
76
76
77
+
77
78
# ⚡ Getting Started
78
79
79
80
## 🔋 Installation
80
81
81
82
The installation is as follows:
82
83
83
-
First, there is a pre-requisite to use [`node`](https://www.npmjs.com/) version 14.20.0 exactly. One can do this by installing the [`nvm`](https://github.com/nvm-sh/nvm) utility and then doing
84
+
First, there is a pre-requisite to use [`node`](https://www.npmjs.com/) version 14.20.0 exactly. One can do this by installing the [`nvm`](https://github.com/nvm-sh/nvm) utility and then doing
84
85
85
86
```
86
87
nvm install 14.20.0
@@ -120,11 +121,11 @@ Which will serve the dashboard with the server at `http://localhost:8080`, with
120
121
121
122
## 👨👦 Relationship with ZenML
122
123
123
-
The ZenML Dashboard is a Javascript React-based application that lives inside this repository, which is a sister repository of the main [ZenML Python package repo](https://github.com/zenml-io/zenml).
124
+
The ZenML Dashboard is a Javascript React-based application that lives inside this repository, which is a sister repository of the main [ZenML Python package repo](https://github.com/zenml-io/zenml).
124
125
125
126
> **Note** - The ZenML Dashboard is meant to be used with the ZenML Server as a backend and cannot be used standalone.
126
127
127
-
The dashboard build files come bundled into the [ZenML PyPi package](https://pypi.org/workspace/zenml/) and can be [served locally](https://docs.zenml.io/getting-started/deploying-zenml/using-cli.md) and/or [deployed on the cloud](https://docs.zenml.io/getting-started/deploying-zenml/deployment.md) through the main ZenML python package.
128
+
The dashboard build files come bundled into the [ZenML PyPi package](https://pypi.org/project/zenml/) and can be [served locally](https://docs.zenml.io/getting-started/deploying-zenml/using-cli.md) and/or [deployed on the cloud](https://docs.zenml.io/getting-started/deploying-zenml/deployment.md) through the main ZenML python package.
128
129
129
130
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](https://github.com/zenml-io/zenml-dashboard/releases) section of this GitHub repo). Therefore, each ZenML PyPi package has bundled in it a corresponding version of this dashboard.
130
131
@@ -140,7 +141,7 @@ Which creates a local daemon that serves the files in a [FastAPI](https://github
140
141
141
142
## 🪐 Deploying the dashboard
142
143
143
-
You can deploy this dashboard on supported cloud providers with ZenML python package by using the command:
144
+
You can deploy this dashboard on supported cloud providers with ZenML python package by using the command:
144
145
145
146
```
146
147
zenml deploy
@@ -159,44 +160,44 @@ Just don't forget to the set the `REACT_APP_BASE_API_URL` environment variable!
159
160

160
161
161
162
## 🏠 Home Page
162
-
163
163

164
164
165
165
## 🗂 Pipelines, Stacks and Components
166
-
167
166

168
167
168
+
169
169
# 🙌 Contributing
170
170
171
171
We would love to develop ZenML together with our community! Best way to get
172
172
started is to select any issue from the [`good-first-issue`
If you would like to contribute, please review our [Contributing
176
176
Guide](CONTRIBUTING.md) for all relevant details.
177
177
178
+
178
179
# 👩👩👧👦 Meet the Team
179
180
180
181

181
182
182
-
Every week, the ZenML [core team](https://zenml.io/company#CompanyTeam) will pop in for 30 minutes to interact directly with the community.
183
-
Sometimes we'll be presenting a feature, other times we'll take questions and have fun.
183
+
Every week, the ZenML [core team](https://zenml.io/company#CompanyTeam) will pop in for 30 minutes to interact directly with the community.
184
+
Sometimes we'll be presenting a feature, other times we'll take questions and have fun.
184
185
185
186
[Register now](https://zenml.io/meet) for the ZenML Meet the Community session. It's free and open to everyone.
186
187
187
-
Or subscribe to our [public events calendar](https://calendar.google.com/calendar/u/0/r?cid=Y19iaDJ0Zm44ZzdodXBlbnBzaWplY3UwMmNjZ0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) to get notified
188
+
Or subscribe to our [public events calendar](https://calendar.google.com/calendar/u/0/r?cid=Y19iaDJ0Zm44ZzdodXBlbnBzaWplY3UwMmNjZ0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) to get notified
188
189
before every community gathering.
189
190
190
191
# 🆘 Getting Help
191
-
192
192
By far the easiest and fastest way to get a response is to:
193
193
194
194
1. Ask your questions in [our Slack group](https://zenml.io/slack-invite/).
195
195
2.[Open an issue](https://github.com/zenml-io/zenml-dashboard/issues/new/choose) on our GitHub repo.
196
196
197
+
197
198
# 📜 License
198
199
199
-
ZenML Dashboard is distributed under the terms of the Apache License Version 2.0.
200
+
ZenML Dashboard is distributed under the terms of the Apache License Version 2.0.
200
201
A complete version of the license is available in the [LICENSE](LICENSE) file in
201
-
this repository. Any contribution made to this workspace will be licensed under
202
+
this repository. Any contribution made to this project will be licensed under
0 commit comments