forked from phoenix/litellm-mirror
docs(contributing.md): add docs for contributing to litellm ui
This commit is contained in:
parent
64d268745b
commit
308c73fca9
2 changed files with 44 additions and 0 deletions
43
docs/my-website/docs/contributing.md
Normal file
43
docs/my-website/docs/contributing.md
Normal file
|
@ -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
|
||||||
|
```
|
|
@ -154,6 +154,7 @@ const sidebars = {
|
||||||
"rules",
|
"rules",
|
||||||
"set_keys",
|
"set_keys",
|
||||||
"budget_manager",
|
"budget_manager",
|
||||||
|
"contributing",
|
||||||
"secret",
|
"secret",
|
||||||
"completion/token_usage",
|
"completion/token_usage",
|
||||||
"load_test",
|
"load_test",
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue