Skip to content

Commit 2b01ca8

Browse files
Ismael CruzIsmael Cruz
authored andcommitted
update to reflect chainlit auth removal, add details for installation tools
1 parent 91b8dce commit 2b01ca8

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ This repo contains a docker-compose environment that will run the following comp
6363

6464
# Quick start
6565

66-
1. Install Docker if you don't have it already, see [here](https://www.docker.com/products/docker-desktop/)
66+
1. Install Docker if you don't have it already, see [here](https://www.docker.com/products/docker-desktop/). It will also be helpful to get Docker Desktop to manage the different containers. In addition, ensure you have python installed (version not later than 3.11.9).
67+
6768
2. Check out the Data Recipes AI GitHub repo
6869

6970
Go to the [repo](https://github.com/datakind/data-recipes-ai) in Github, and click the big green '<> Code' button. This provides a few options, you can download a zip file, or check the code out with git. If you have Git installed, a common method would be ...
@@ -125,7 +126,9 @@ This repo contains a docker-compose environment that will run the following comp
125126
126127
7. Restart so the assistant ID is set, `docker compose up -d`
127128
128-
8. Go to [http://localhost:8000/](http://localhost:8000/) and sign-in using the values in your `.env` file for `USER_LOGIN` and `USER_PASSWORD`
129+
8. Go to [http://localhost:8000/](http://localhost:8000/).
130+
131+
9. It will also be helpful to have a database tool like [DBeaver](https://dbeaver.io) to access and interact with your data and recipes.
129132
130133
## Stoping/Starting the environment
131134
@@ -135,6 +138,8 @@ The steps above are mostly one-time. Going forward you only need to stop and sta
135138
- To start the environment `docker compose up -d`, then go to [http://localhost:8000/](http://localhost:8000/)
136139
- To start with rebuild `docker compose up -d --build` (for more details about development, see [CONTRIBUTION](CONTRIBUTION.md))
137140
141+
You can also do the above through Docker Desktop.
142+
138143
## Using Recipes
139144
140145
We are in a phase of research to identify and improve recipes, but for now the system comes with some basic examples to illustrate. To find out the list, enter "Get all recipes" in the chat interface.

0 commit comments

Comments
 (0)