From 308c73fca9b13d736ebaa4ee0e14447fade0ad9a Mon Sep 17 00:00:00 2001
From: Krrish Dholakia <krrishdholakia@gmail.com>
Date: Fri, 23 Feb 2024 13:01:30 -0800
Subject: [PATCH] docs(contributing.md): add docs for contributing to litellm
 ui

---
 docs/my-website/docs/contributing.md | 43 ++++++++++++++++++++++++++++
 docs/my-website/sidebars.js          |  1 +
 2 files changed, 44 insertions(+)
 create mode 100644 docs/my-website/docs/contributing.md

diff --git a/docs/my-website/docs/contributing.md b/docs/my-website/docs/contributing.md
new file mode 100644
index 000000000..da5783d9c
--- /dev/null
+++ b/docs/my-website/docs/contributing.md
@@ -0,0 +1,43 @@
+# Contributing - UI
+
+Here's how to run the LiteLLM UI locally for making changes: 
+
+## 1. Clone the repo 
+```bash
+git clone https://github.com/BerriAI/litellm.git
+```
+
+## 2. Start the UI + Proxy 
+
+**2.1 Start the proxy on port 4000** 
+
+Tell the proxy where the UI is located
+```bash
+export PROXY_BASE_URL="http://localhost:3000/"
+```
+
+```bash
+cd litellm/litellm/proxy
+python3 proxy_cli.py --config /path/to/config.yaml --port 4000
+```
+
+**2.2 Start the UI**
+
+Set the mode as development (this will assume the proxy is running on localhost:4000)
+```bash
+export NODE_ENV="development" 
+```
+
+```bash
+cd litellm/ui/litellm-dashboard
+
+npm run dev
+
+# starts on http://0.0.0.0:3000/ui
+```
+
+## 3. Go to local UI 
+
+```
+http://0.0.0.0:3000/ui
+```
\ No newline at end of file
diff --git a/docs/my-website/sidebars.js b/docs/my-website/sidebars.js
index 72c9cf196..86112b6d2 100644
--- a/docs/my-website/sidebars.js
+++ b/docs/my-website/sidebars.js
@@ -154,6 +154,7 @@ const sidebars = {
     "rules",
     "set_keys",
     "budget_manager",
+    "contributing",
     "secret",
     "completion/token_usage",
     "load_test",