Skip to content

prerequisites.md

Latest commit

 

History

History
113 lines (69 loc) · 2.67 KB

prerequisites.md

File metadata and controls

113 lines (69 loc) · 2.67 KB

🛠️ Prerequisites

Before running this project locally, ensure the following tools are installed on your system.

1. Git

Required to clone the repository and switch between tutorial branches.

Installation:

  • Linux: sudo apt install git (Ubuntu/Debian)
  • macOS: brew install git or download from git-scm.com
  • Windows: Download from git-scm.com or use winget install Git.Git

Verify: git --version

2. UV

We use UV for fast Python environment and dependency management. UV automatically handles Python installation and virtual environments.

Installation:

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Verify: uv --version

3. PostgreSQL Client

Required to connect to PostgreSQL databases.

macOS:

brew install postgresql

Linux (Ubuntu/Debian):

sudo apt install postgresql-client

Windows:

Verify: psql --version

4. Docker (Optional)

Used for containerized deployment and running PostgreSQL locally during development.

Installation:

Verify: docker --version

5. Python IDE (Recommended)

Use any Python-compatible code editor:

  • VS Code - Popular, free, extensive Python support
  • Cursor - AI-native IDE based on VS Code (recommended for AI development)
  • WindSurf - Another AI-native IDE based on VS Code (recommended for AI development)

✅ Quick Setup Verification

After installing the prerequisites, verify your setup:

# Check all tools
git --version
uv --version
psql --version
docker --version  # (optional)

🔧 Troubleshooting

UV not found after installation:

  • Restart your terminal
  • Check if UV is in your PATH: echo $PATH (Linux/macOS) or $env:PATH (Windows)

PostgreSQL libraries not found:

  • Ensure development headers are installed (libpq-dev on Linux)
  • On Windows, make sure PostgreSQL bin directory is in PATH

Docker permission issues (Linux):

sudo usermod -aG docker $USER
# Log out and back in

Ready to proceed? Return to the README for project setup!