Skip to content

Getting Started

This section covers everything you need to set up your development environment and start contributing to the Freeze Design webshop.

Prerequisites

Before you begin, ensure you have the following installed:

  • Python 3.14
  • Node.js 22+
  • PostgreSQL 15+
  • Redis 7+
  • Docker (recommended — docker-compose.dev.yml provides PostgreSQL, Redis, and RabbitMQ)

Sections

Installation Steps

git clone https://github.com/Voorman/webshop_freeze_design.git
cd webshop_freeze_design
./manage.sh setup

The setup script installs both runtimes' dependencies, prepares the backend environment, starts the Docker development services, applies migrations, and optionally imports seed data. Use the installation guide for manual setup and platform-specific notes.

First Run

./manage.sh start
./manage.sh status

Open http://localhost:3000 for the storefront and http://localhost:8000/api/health/ for the backend health response.

Common Setup Issues

  • Docker is installed but unavailable: start Docker Desktop before rerunning setup or start.
  • Port 5432 is already occupied: stop the local PostgreSQL service so the development container can bind its configured port.
  • Backend configuration is missing: copy backend/.env.example to backend/.env; the setup command normally does this automatically.
  • Frontend packages or Playwright browsers are missing: run npm install or npx playwright install --with-deps from frontend/ as appropriate.

Next Steps

  • Read Configuration before changing environment-specific behavior.
  • Use the Development Guide for build, lint, branch, and pull-request conventions.
  • Use the Testing Guide to select the right local and CI test commands.