Improvements in the codebase

.gitignore

@@ -1,5 +1,7 @@
 # dependencies
+node_modules
 backend/node_modules
+backend/dist
 
 backend/.env
 frontend/.env
@@ -12,4 +14,4 @@ frontend/build
 
 # ide
 .vscode
-.idea
+.idea

README.md

@@ -32,17 +32,33 @@ kubectl port-forward svc/volcano-dashboard 8080:80 -n volcano-system --address 0
 
 Access the dashboard by navigate to `http://$YOUR_NODE_IP:8080` in your browser.
 
+If running locally navigate to `http://localhost:8080`
 
-## Development
 
-You can build the volcano dashboard images locally. Please use the following command to build docker images of volcano dashboard.
+## Development
 
 Clone the repo.
 
 ```shell
 git clone https://github.com/volcano-sh/dashboard.git
 ```
 
+### Locally
+
+Follow the prerequisites to install volcano first
+
+```shell
+npm install
+```
+
+```shell
+npm run dev
+```
+
+
+### Inside kubernetes cluster
+You can build the volcano dashboard images locally. Please use the following command to build docker images of volcano dashboard.
+
 Build images.
 ```shell
 // build frontend image.
@@ -52,3 +68,7 @@ docker build -t backend:dev . -f deployment/build/backend/Dockerfile
 ```
 
 After that you can replace the images in `volcano-dashboard.yaml` to verify the result.
+
+```shell
+kubectl apply -f deployment/volcano-dashboard.yaml
+```

backend/.babelrc

@@ -1,33 +1,31 @@
 {
-  "presets": [
-    "@babel/preset-env"
-  ],
-  "plugins": [
-    "@babel/plugin-syntax-dynamic-import",
-    "@babel/plugin-syntax-import-meta",
-    "@babel/plugin-proposal-class-properties",
-    "@babel/plugin-proposal-json-strings",
-    [
-      "@babel/plugin-proposal-decorators",
-      {
-        "legacy": true
-      }
-    ],
-    "@babel/plugin-proposal-function-sent",
-    "@babel/plugin-proposal-export-namespace-from",
-    "@babel/plugin-proposal-numeric-separator",
-    "@babel/plugin-proposal-throw-expressions",
-    "@babel/plugin-proposal-export-default-from",
-    "@babel/plugin-proposal-logical-assignment-operators",
-    "@babel/plugin-proposal-optional-chaining",
-    [
-      "@babel/plugin-proposal-pipeline-operator",
-      {
-        "proposal": "minimal"
-      }
-    ],
-    "@babel/plugin-proposal-nullish-coalescing-operator",
-    "@babel/plugin-proposal-do-expressions",
-    "@babel/plugin-proposal-function-bind"
-  ]
+    "presets": ["@babel/preset-env", "@babel/preset-typescript"],
+    "plugins": [
+        "@babel/plugin-syntax-dynamic-import",
+        "@babel/plugin-syntax-import-meta",
+        "@babel/plugin-proposal-class-properties",
+        "@babel/plugin-proposal-json-strings",
+        [
+            "@babel/plugin-proposal-decorators",
+            {
+                "legacy": true
+            }
+        ],
+        "@babel/plugin-proposal-function-sent",
+        "@babel/plugin-proposal-export-namespace-from",
+        "@babel/plugin-proposal-numeric-separator",
+        "@babel/plugin-proposal-throw-expressions",
+        "@babel/plugin-proposal-export-default-from",
+        "@babel/plugin-proposal-logical-assignment-operators",
+        "@babel/plugin-proposal-optional-chaining",
+        [
+            "@babel/plugin-proposal-pipeline-operator",
+            {
+                "proposal": "minimal"
+            }
+        ],
+        "@babel/plugin-proposal-nullish-coalescing-operator",
+        "@babel/plugin-proposal-do-expressions",
+        "@babel/plugin-proposal-function-bind"
+    ]
 }

backend/.prettierrc

@@ -0,0 +1,6 @@
+{
+    "tabWidth": 4,
+    "singleQuote": false,
+    "semi": true,
+    "trailingComma": "none"
+}

backend/nodemon.json

@@ -0,0 +1,6 @@
+{
+    "watch": ["src"],
+    "ext": "ts,js",
+    "ignore": ["node_modules"],
+    "exec": "tsc --noEmit && tsx ./src/server.ts"
+}