Merge pull request #265 from tardigrde/main

Improve dev setup docs

README.md

@@ -73,30 +73,50 @@ To stop just run Ctrl + C
 
 ## Development environments
 
-Spin up only 2 containers from docker-compose.yaml (by deleting all services except for redis and mongo)
-
-Make sure you have python 3.10 or 3.11 installed
-
-1. Navigate to `/application` folder
-2. Run `docker-compose -f docker-compose-dev.yaml build && docker-compose -f docker-compose-dev.yaml up -d`
-3. Export required variables              
-`export CELERY_BROKER_URL=redis://localhost:6379/0`   
-`export CELERY_RESULT_BACKEND=redis://localhost:6379/1`
-`export MONGO_URI=mongodb://localhost:27017/docsgpt`
-4. Install dependencies
-`pip install -r requirements.txt`
-5. Prepare .env file
-Copy .env_sample and create .env with your openai api token
-6. Run the app
+### Spin up mongo and redis
+For development only 2 containers are used from docker-compose.yaml (by deleting all services except for redis and mongo). 
+See file [docker-compose-dev.yaml](./docker-compose-dev.yaml).
+
+Run
+```
+docker compose -f docker-compose-dev.yaml build
+docker compose -f docker-compose-dev.yaml up -d
+```
+
+### Run the backend
+
+Make sure you have Python 3.10 or 3.11 installed.
+
+1. Export required environment variables
+```commandline
+export CELERY_BROKER_URL=redis://localhost:6379/0   
+export CELERY_RESULT_BACKEND=redis://localhost:6379/1
+export MONGO_URI=mongodb://localhost:27017/docsgpt
+```
+2. Prepare .env file
+Copy `.env_sample` and create `.env` with your OpenAI API token
+3. (optional) Create a python virtual environment
+```commandline
+python -m venv venv
+. venv/bin/activate
+```
+4. Change to `application/` subdir and install dependencies for the backend
+```commandline
+cd application/ 
+pip install -r requirements.txt
+```
+5 . Run the app
 `python wsgi.py`
-7. Start worker with `celery -A app.celery worker -l INFO`
+6. Start worker with `celery -A app.celery worker -l INFO`
+
+### Start frontend 
+Make sure you have Node version 16+
 
-To start frontend
 1. Navigate to `/frontend` folder
 2. Install dependencies
 `npm install`
-3. Run the app
-4. `npm run dev`
+3. Run the app 
+`npm run dev`
 
 
 [How to install the Chrome extension](https://github.com/arc53/docsgpt/wiki#launch-chrome-extension)

application/Dockerfile

@@ -8,18 +8,16 @@ RUN pip install --upgrade pip && pip install tiktoken==0.3.3
 COPY requirements.txt .
 RUN pip install -r requirements.txt
 
-
 FROM python:3.10-slim-bullseye
-# Copy pre-built packages from builder stage
-COPY --from=builder /usr/local/lib/python3.10/site-packages/ /usr/local/lib/python3.10/site-packages/
-RUN pip install gunicorn==20.1.0
-RUN pip install celery==5.2.7
+
+# Copy pre-built packages and binaries from builder stage
+COPY --from=builder /usr/local/ /usr/local/
+
 WORKDIR /app
 COPY . /app
 ENV FLASK_APP=app.py
 ENV FLASK_DEBUG=true
 
-
 EXPOSE 5001
 
 CMD ["gunicorn", "-w", "2", "--timeout", "120", "--bind", "0.0.0.0:5001", "wsgi:app"]

application/requirements.txt

@@ -10,6 +10,7 @@ billiard==3.6.4.0
 blobfile==2.0.1
 boto3==1.26.102
 botocore==1.29.102
+celery==5.2.7
 cffi==1.15.1
 charset-normalizer==3.1.0
 click==8.1.3
@@ -30,6 +31,7 @@ Flask==2.2.3
 Flask-Cors==3.0.10
 frozenlist==1.3.3
 geojson==2.5.0
+gunicorn==20.1.0
 greenlet==2.0.2
 gpt4all==0.1.7
 hub==3.0.1
@@ -52,6 +54,7 @@ multidict==6.0.4
 multiprocess==0.70.14
 mypy-extensions==1.0.0
 networkx==3.0
+npx
 nltk==3.8.1
 numcodecs==0.11.0
 numpy==1.24.2
@@ -87,12 +90,13 @@ s3transfer==0.6.0
 scikit-learn==1.2.2
 scipy==1.10.1
 sentence-transformers==2.2.2
-sentencepiece==0.1.97
+sentencepiece
 six==1.16.0
 SQLAlchemy==1.4.46
 sympy==1.11.1
 tenacity==8.2.2
 threadpoolctl==3.1.0
+tiktoken
 torch==2.0.0
 torchvision==0.15.1
 tqdm==4.65.0

docker-compose.yaml

@@ -1,6 +1,15 @@
 version: "3.9"
 
 services:
+  frontend:
+    build: ./frontend
+    environment:
+      - VITE_API_HOST=http://localhost:5001
+      - VITE_API_STREAMING=$VITE_API_STREAMING
+    ports:
+      - "5173:5173"
+    depends_on:
+      - backend
 
   backend:
     build: ./application