Skip to content

Commit 8901092

Browse files
committed
add dev instructions about keys
1 parent 2749a2a commit 8901092

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

DEVELOPMENT.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,21 @@ How to set up your local machine.
1818
```bash
1919
pip install -r requirements.txt
2020
```
21+
- **Configure environment variable (optional)s**
22+
- copy `api-keys.env.example` to `api-keys.env` and add your API keys.
23+
- required fields for different providers are different, please refer to the [LiteLLM setup](https://docs.litellm.ai/docs#litellm-python-sdk) guide for more details.
24+
- currently only endpoint, model, api_key, api_base, api_version are supported.
25+
- this helps data formulator to automatically load the API keys when you run the app, so you don't need to set the API keys in the app UI.
2126
22-
- **Run**
27+
- **Run the app**
2328
- **Windows**
2429
```bash
2530
.\local_server.bat
2631
```
2732
2833
- **Unix-based**
2934
```bash
30-
.\local_server.sh
35+
./local_server.sh
3136
```
3237
3338
## Frontend (TypeScript)

0 commit comments

Comments
 (0)