Skip to content

setup.md

Latest commit

 

History

History
90 lines (60 loc) · 1.5 KB

setup.md

File metadata and controls

90 lines (60 loc) · 1.5 KB

Development Setup

Set up your development environment.

Prerequisites

  • Python 3.11+
  • Node.js 18+
  • Docker & Docker Compose (optional — for compatibility only)
  • Git
  • PostgreSQL 15.15+ (CVE-2025-12817/12818 patched)
  • Redis 7.4.2+ (CVE-2025-49844 defense)

Security Note: Container images in docker-compose.local.yml are pinned to security-patched versions. If running locally without Docker, ensure your PostgreSQL and Redis versions include these patches.

Backend Setup

cd backend

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Set up database
createdb residency_scheduler

# Run migrations
alembic upgrade head

# Start development server
uvicorn app.main:app --reload

Frontend Setup

cd frontend

# Install dependencies
npm install

# Start development server
npm run dev

Docker Development (Optional)

Note: Native macOS is the primary development workflow. Docker is maintained for compatibility only.

For full-stack development with Docker:

# Start all services with hot reload
docker-compose -f docker-compose.yml -f docker-compose.local.yml up

# View logs
docker-compose logs -f backend

IDE Setup

VS Code

Recommended extensions:

  • Python
  • Pylance
  • ESLint
  • Prettier
  • Tailwind CSS IntelliSense

PyCharm

Configure:

  • Python interpreter (venv)
  • Django/FastAPI support
  • Database tools