Skip to content

Commit 046bc16

Browse files
docs: update README.md with clearer instructions (#47)
* Update README.md with clearer instructions * Requested changes/ fixes
1 parent 2e8cee3 commit 046bc16

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ We use the [HTTP protocol for AI chat apps](https://github.com/Azure-Samples/ai-
5454

5555
There are multiple ways to get started with this project.
5656

57-
The quickest way to use [GitHub Codespaces](#use-github-codespaces) that provides a preconfigured environment for you. Alternatively, you can [set up your local environment](#use-your-local-environment) following the instructions below.
57+
The quickest way is to use [GitHub Codespaces](#use-github-codespaces) that provides a preconfigured environment for you. Alternatively, you can [set up your local environment](#use-your-local-environment) following the instructions below.
5858

5959
> [!IMPORTANT]
6060
> If you want to run this sample entirely locally using Ollama, you have to follow the instructions in the [local environment](#use-your-local-environment) section.
@@ -75,10 +75,11 @@ Then you can get the project code:
7575

7676
1. [**Fork**](https://github.com/Azure-Samples/serverless-chat-langchainjs/fork) the project to create your own copy of this repository.
7777
2. On your forked repository, select the **Code** button, then the **Local** tab, and copy the URL of your forked repository.
78+
7879
<div align="center">
7980
<img src="./docs/images/clone-url.png" alt="Screenshot showing how to copy the repository URL" width="400px" />
8081
</div>
81-
3. Open a terminal and run this command to clone the repo: `git clone <your-repo-url>`
82+
3. Open a terminal and run this command to clone the repo: <code> git clone &lt;your-repo-url&gt; </code>
8283

8384
### Use GitHub Codespaces
8485

@@ -116,13 +117,13 @@ After that you have to install the NPM dependencies:
116117
npm install
117118
```
118119

119-
Then you can start the application by running the commands:
120+
Then you can start the application by running the following command which will start the web app and the API locally:
120121

121122
```bash
122123
npm start
123124
```
124125

125-
This will start the web app and the API locally. Then we need to upload the PDF documents from the `/data` folder to the API with the command:
126+
Then, open a new terminal running concurrently and run the following command to upload the PDF documents from the `/data` folder to the API:
126127

127128
```bash
128129
npm run upload:docs
@@ -141,13 +142,13 @@ First you need to provision the Azure resources needed to run the sample. Follow
141142

142143
Once your deployment is complete, you should see a `.env` file in the `packages/api` folder. This file contains the environment variables needed to run the application using Azure resources.
143144

144-
To run the sample, you can then use the same commands as for the Ollama setup:
145+
To run the sample, you can then use the same commands as for the Ollama setup. This will start the web app and the API locally:
145146

146147
```bash
147148
npm start
148149
```
149150

150-
This will start the web app and the API locally. Open the URL `http://localhost:8000` in your browser to start chatting with the bot.
151+
Open the URL `http://localhost:8000` in your browser to start chatting with the bot.
151152

152153
Note that the documents are uploaded automatically when deploying the sample to Azure with `azd up`.
153154

@@ -159,7 +160,6 @@ Note that the documents are uploaded automatically when deploying the sample to
159160
#### Azure prerequisites
160161

161162
- **Azure account**. If you're new to Azure, [get an Azure account for free](https://azure.microsoft.com/free) to get free Azure credits to get started. If you're a student, you can also get free credits with [Azure for Students](https://aka.ms/azureforstudents).
162-
163163
- **Azure subscription with access enabled for the Azure OpenAI service**. You can request access with [this form](https://aka.ms/oaiapply).
164164

165165
#### Deploy the sample

0 commit comments

Comments
 (0)