Skip to content

Commit 1ff15d0

Browse files
authored
docs: include .env.example instructions in README (#26)
* explain how to copy env.exmple * update env.example
1 parent bdb83ca commit 1ff15d0

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

.env.example

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ API_PORT=8000
1313
LLM_MODEL=gpt-3.5-turbo
1414
LLM_API_KEY=your-api-key-here
1515
LLM_ENGINE_PORT=8001
16+
LLM_ENGINE_URL=http://llm_engine:8001
1617

1718
# Query Router Configuration
1819
QUERY_ROUTER_PORT=8002
1920

20-
RUST_LOG=debug
21+
RUST_LOG=debug

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Lucidata is an LLM based query tool designed to democratize data access. It tran
2020
### Prerequisites
2121

2222
- `docker` installed
23-
- An OpenAPI `API_KEY`
23+
- An OpenAI `API_KEY`
2424

2525
### Usage
2626

@@ -30,13 +30,19 @@ Lucidata is an LLM based query tool designed to democratize data access. It tran
3030
cd lucidata
3131
```
3232

33-
2. Build and start the application with `docker compose`:
33+
2. Copy the example environment file and edit it to include your OpenAI key:
34+
```bash
35+
cp .env.example .env
36+
# Edit the .env file to include your OpenAI key ...
37+
```
38+
39+
3. Build and start the application with `docker compose`:
3440
```bash
3541
docker compose build # it can take a while to compile, be patient :-)
3642
docker compose up
3743
```
3844

39-
3. Send your query to the query_router endpoint, and check out the results!
45+
4. Send your query to the query_router endpoint, and check out the results!
4046
``` bash
4147
curl -X POST "http://localhost:8002/translate-and-execute" \
4248
-H "Content-Type: application/json" \
@@ -45,7 +51,7 @@ curl -X POST "http://localhost:8002/translate-and-execute" \
4551
}'
4652
```
4753

48-
4. (Optional) Pipe the output to the `jq` CLI:
54+
5. (Optional) Pipe the output to the `jq` CLI:
4955
``` bash
5056
curl -X POST "http://localhost:8002/translate-and-execute" \
5157
-H "Content-Type: application/json" \

0 commit comments

Comments
 (0)