Skip to content

Update README.md #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avriiil wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84c618b
Update README.md
avriiil Oct 4, 2023
68e4a02
Merge branch 'Boburmirzo:main' into main
avriiil Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,13 +128,7 @@ The sample project does the following procedures to achieve the above output:

## How to run the project

Example only supports Unix-like systems (such as Linux, macOS, BSD). If you are a Windows user, we highly recommend leveraging Windows Subsystem for Linux (WSL) or Dockerize the app to run as a container.

### Run with Docker

1. [Set environment variables](#step-2-set-environment-variables)
2. From the project root folder, open your terminal and run `docker compose up`.
3. Navigate to `localhost:8501` on your browser when docker installion is successful.
Example only supports Unix-like systems (such as Linux, macOS, BSD). If you are a Windows user, we highly recommend leveraging Windows Subsystem for Linux (WSL) or [Dockerize the app](#run-with-docker) to run as a container.

### Prerequisites

Expand Down Expand Up @@ -181,24 +175,26 @@ RAINFOREST_BASE_URL={RAINFOREST_BASE_URL}
RAINFOREST_API_KEY={RAINFOREST_API_KEY}
```

### Step 3: Install the app dependencies
### Step 3 (Optional): Create a new virtual environment

Install the required packages:
Create a new virtual environment in the same folder and activate that environment:

```bash
pip install --upgrade -r requirements.txt
python -m venv pw-env && source pw-env/bin/activate
```
### Step 4 (Optional): Create a new virtual environment

Create a new virtual environment in the same folder and activate that environment:
### Step 4: Install the app dependencies

Install the required packages:

```bash
python -m venv pw-env && source pw-env/bin/activate
pip install --upgrade -r requirements.txt
```


### Step 5: Run and start to use it

You start the application by navigating to `llm_app` folder and running `main.py`:
Start the application by running `main.py`:

```bash
python main.py
Expand Down Expand Up @@ -249,3 +245,9 @@ Discounted Price: $117.60
Discount Percentage: 10%
Ship Date: 2024-08-09
```

### Run with Docker (for Windows users)

1. [Set environment variables](#step-2-set-environment-variables)
2. From the project root folder, open your terminal and run `docker compose up`.
3. Navigate to `localhost:8501` on your browser when docker installion is successful.