Skip to content

Commit 4c9e6e3

Browse files
committed
[fix] README fix
1 parent 375cf66 commit 4c9e6e3

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,35 @@ Before running the example see [getting started](#getting-started)
4545

4646
You might want to run the app directly on your machine for development purposes OR to use for example Apple GPUs (which are not supported by Docker at the moment).
4747

48+
### Prerequisites
49+
4850
To have it up and running please execute the following steps:
4951

5052
[Download and install Ollama](https://ollama.com/download)
5153
[Download and install Docker](https://www.docker.com/products/docker-desktop/)
5254

55+
### Clone the Repository
56+
57+
First, clone the repository and change current directory to it:
58+
59+
```sh
60+
git clone https://github.com/CatchTheTornado/text-extract-api.git
61+
cd text-extract-api
62+
```
63+
64+
### Setup with `Makefile`
65+
5366
Be default application create [virtual python env](https://docs.python.org/3/library/venv.html): `.venv`. You can disable this functionality on local setup by adding `DISABLE_VENV=1` before running script:
67+
5468
```bash
5569
DISABLE_VENV=1 make install
5670
```
5771
```bash
5872
DISABLE_VENV=1 make run
5973
```
6074

75+
### Manual setup
76+
6177
Configure environment variables:
6278

6379
```bash
@@ -67,6 +83,9 @@ cp .env.localhost.example .env.localhost
6783
You might want to just use the defaults - should be fine. After ENV variables are set, just execute:
6884

6985
```bash
86+
python3 -m venv .venv
87+
source .venv/bin/activate
88+
pip install -e .
7089
chmod +x run.sh
7190
run.sh
7291
```
@@ -212,7 +231,7 @@ The project includes a CLI for interacting with the API. To make it work first r
212231

213232
```bash
214233
cd client
215-
pip install -r requirements.txt
234+
pip install -e .
216235
```
217236

218237

0 commit comments

Comments
 (0)