Dashboard: Dev Guide

dashboard/README.md

@@ -0,0 +1,42 @@
+# Kubeflow's Dashboard for TfJobs
+
+## Developer Guide
+
+### Dependencies
+* [Nodejs](https://nodejs.org/en/)
+* [Yarn](https://yarnpkg.com/en/docs/install)
+
+Then install the dependencies of the frontend React application with:
+```sh
+cd dashboard/frontend
+yarn install
+```
+
+### Starting the dashboard locally
+
+First we need to start the backend server:
+
+```sh
+export KUBECONFIG=$(echo ~/.kube/config)
+go run dashboard/backend/main.go
+```
+
+At this point the backend will be running on port `8080`.
+
+For development, modify `frontend/src/services.js` to point the local backend server (make sure you don't commit this change):
+```js
+let host = "http://localhost:8080";
+```
+
+Start the frontend's development server in another terminal with:
+```sh
+cd dashboard/frontend
+yarn start
+```
+
+The development server will rebuild the application and refresh your browser automatically every time you save a file.
+
+
+
+
+