Skip to content

#207 issue fix - docs update #210

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
Cubix33 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

#207 issue fix - docs update #210

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71ee814
#207 issue fix - docs update
Cubix33 Jan 4, 2026
bf9608f
updated all instances of old docker command
Cubix33 Jan 4, 2026
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
18 changes: 12 additions & 6 deletions docs/INSTALL_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ nano .env # or use your preferred editor
6. **Set up Docker container**
```sh
cd backend
docker-compose up -d # Start weaviate, falkordb, rabbitmq
docker compose up -d # Start weaviate, falkordb, rabbitmq
```

7. **Start Docker containers**
Expand All @@ -83,7 +83,7 @@ npm run dev

## Environment Variables

Create a `.env` file in the project root with the following variables:
1. Create a `.env` file in the project root with the following variables:

### Required Variables
```env
Expand All @@ -102,6 +102,12 @@ SUPABASE_KEY=your_supabase_anon_key_here
# Backend Configuration
BACKEND_URL=http://localhost:8000
```
2. Create an .env file in the frontend folder with the following variables:

```env
VITE_SUPABASE_URL=your_supabase_url_here
VITE_SUPABASE_KEY=your_supabase_anon_key_here
```

### Optional Variables
```env
Expand Down Expand Up @@ -158,7 +164,7 @@ Weaviate is used for semantic search and embeddings storage. It runs in Docker:

```sh
cd backend
docker-compose up -d weaviate
docker compose up -d weaviate
```

The database will be available at `http://localhost:8080`
Expand Down Expand Up @@ -235,8 +241,8 @@ npm run lint # Run ESLint
docker ps

# Restart Weaviate
docker-compose down
docker-compose up -d weaviate
docker compose down
docker compose up -d weaviate
```

3. **Missing environment variables**
Expand All @@ -250,7 +256,7 @@ npm run lint # Run ESLint

### Logs
- Backend logs are displayed in the terminal where you run `python main.py`
- Check Docker logs for Weaviate: `docker-compose logs weaviate`
- Check Docker logs for Weaviate: `docker compose logs weaviate`

## Project Structure

Expand Down