Skip to content

Commit d9f211e

Browse files
committed
docs: update readme
1 parent 77a67ef commit d9f211e

File tree

1 file changed

+8
-33
lines changed

1 file changed

+8
-33
lines changed

README.md

Lines changed: 8 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -5,60 +5,35 @@ In this workshop, we will build a chatbot based on OpenAI language models and im
55

66
This workshop exists in different variants:
77

8-
- 👉 [**See the workshop using Azure AI Search**](https://aka.ms/ws/openai-rag): we will use [Azure AI Search](https://azure.microsoft.com/services/search/) to index and search the documents.
8+
- 👉 [**See the workshop using Node.js + Azure AI Search**](https://aka.ms/ws/openai-rag): we will use [Azure AI Search](https://azure.microsoft.com/services/search/) to index and search the documents.
99

10-
- 👉 [**See the workshop using Qdrant**](https://aka.ms/ws/openai-rag-qdrant): we will use [Qdrant](https://qdrant.tech/) to index and search the documents.
10+
- 👉 [**See the workshop using Node.js + Qdrant**](https://aka.ms/ws/openai-rag-qdrant): we will use [Qdrant](https://qdrant.tech/) to index and search the documents.
1111

12+
- 👉 [**See the workshop using Java / Quarkus + Qdrant**](https://aka.ms/ws/openai-rag-quarkus): we will use [Qdrant](https://qdrant.tech/) to index and search the documents.
1213

13-
14-
👉 [See the completed solution and workshop source](https://github.com/Azure-Samples/azure-openai-rag-workshop/tree/base)
14+
💡 [See the completed solution and workshop source for all versions](https://github.com/Azure-Samples/azure-openai-rag-workshop/tree/base)
1515

1616
## Prerequisites
1717

18-
- **Node.js v20+**
19-
- **Docker v20+**
2018
- **Azure account**. If you're new to Azure, [get an Azure account for free](https://azure.microsoft.com/free/?WT.mc_id=javascript-0000-cxa) to get free Azure credits to get started.
2119
- **Azure subscription with access enabled for the Azure OpenAI service**. You can request access with [this form](https://aka.ms/oaiapply).
2220

2321
You can use [GitHub Codespaces](https://github.com/features/codespaces) to work on this project directly from your browser: select the **Code** button, then the **Codespaces** tab and click on **Create Codespaces on main**.
2422

25-
You can also use the [Dev Containers extension for VS Code](https://aka.ms/vscode/ext/devcontainer) to work locally using a ready-to-use dev environment.
23+
You can also use Docker and the [Dev Containers extension for VS Code](https://aka.ms/vscode/ext/devcontainer) to work locally using a ready-to-use dev environment.
2624

2725
## Project details
2826

29-
This project is structured as monorepo and makes use of [NPM Workspaces](https://docs.npmjs.com/cli/using-npm/workspaces).
27+
This project is structured as monorepo, all packages source code is located under the `src/` folder.
3028

3129
Here's the architecture of the application:
3230

3331
![Architecture diagram](https://github.com/Azure-Samples/azure-openai-rag-workshop/blob/base/docs/assets/architecture.png)
3432

35-
## How to run locally
36-
37-
```bash
38-
npm install
39-
npm start
40-
```
41-
42-
This command will start the frontend and backend services.
43-
For these services to work, you need to have a `.env` file at the root of the project with at least the following content:
44-
45-
```bash
46-
AZURE_SEARCH_SERVICE=<your_azure_ai_search_instance_name>
47-
AZURE_OPENAI_URL=<you_openai_instance_url>
48-
```
49-
50-
The application will then be available at `http://localhost:8000`.
51-
52-
## How to build Docker images
53-
54-
```bash
55-
npm run docker:build
56-
```
57-
58-
This command will build the container images for all services.
59-
6033
## How deploy to Azure
6134

35+
Before deploying to Azure, you need to install the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd). Once you're ready, run the following commands:
36+
6237
```bash
6338
azd auth login
6439
azd up

0 commit comments

Comments
 (0)