Skip to content

prereqs-setup-guide.md

Latest commit

 

History

History
115 lines (77 loc) · 2.21 KB

prereqs-setup-guide.md

File metadata and controls

115 lines (77 loc) · 2.21 KB

Prerequisites Setup Guide

Follow these steps in order. Check first — if the command prints a version, skip to the next step.

Step 1 — Git

git --version

If not installed:

macOS Windows Linux
brew install git winget install Git.Git sudo apt install git

Step 2 — Python 3.13

python3.13 --version

If not installed:

macOS Windows Linux
brew install python@3.13 Download from python.org/downloads — check "Add Python to PATH" sudo apt install python3.13 python3.13-venv python3.13-pip

Step 3 — Node.js 20+

node --version && npm --version

If not installed:

macOS / Linux Windows
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash then nvm install 20 && nvm use 20 winget install OpenJS.NodeJS.LTS

Step 4 — Docker Desktop

docker --version

If not installed, download from docker.com/products/docker-desktop. Once installed, open Docker Desktop and keep it running.

Linux: Docker Engine works fine without Docker Desktop.

Step 5 — GitHub account

Sign up at github.com if you don't have one, then:

git config --global user.name "Your Name"
git config --global user.email "you@example.com"

Step 6 — Gemini API key

  1. Go to aistudio.google.com/app/apikey
  2. Sign in with any Google account
  3. Click Create API key and copy it

Step 7 — Clone the repo and install dependencies

git clone <repo-url>
cd <project-folder>
cp .env.example .env

Open .env and paste your key:

GEMINI_API_KEY=your_key_here

Backend:

cd backend
python3.13 -m venv venv
source venv/bin/activate        # macOS / Linux
venv\Scripts\activate           # Windows
pip install -r requirements.txt

Frontend:

cd ../frontend && npm install

Final check

git --version && python3.13 --version && node --version && npm --version && docker --version

All five print versions? You're ready.