Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Docker (New)
.docker/
postgres_data/
docker-compose.override.yml

# Security & Python (Standard)
.env
__pycache__/
*.py[cod]
venv/
Data/
*.db
*.json
*.csv
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,14 @@ Repository Finder is a tool that identifies and analyzes open-source repositorie
```
GITHUB_TOKEN=your_personal_access_token
OPENAI_API_KEY=your_openai_token # Optional: only needed for LLM-based models
```
### Database Setup (Optional)
To run a production-ready PostgreSQL database instead of the default SQLite:

1. Ensure [Docker Desktop](https://www.docker.com/products/docker-desktop/) is installed and running.
2. Start the database:
```bash
docker-compose up -d
```

## Scraping

Expand Down
18 changes: 18 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: '3.8'

services:
db:
image: postgres:15-alpine
container_name: repofinder_postgres
restart: always
environment:
POSTGRES_USER: ${POSTGRES_USER:-admin}
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-password}
POSTGRES_DB: ${POSTGRES_DB:-repofinder}
ports:
- "5432:5432"
volumes:
- postgres_data:/var/lib/postgresql/data

volumes:
postgres_data: