Skip to content

Docker-Setup-README.md

Latest commit

 

History

History
205 lines (154 loc) · 6.05 KB

Docker-Setup-README.md

File metadata and controls

205 lines (154 loc) · 6.05 KB

GoodFood Application - Setup Guide

This guide provides setup instructions for running the GoodFood application with two different approaches: Docker (recommended for quick setup) and Manual (for developers who prefer local development).

🐳 Setup Option 1: Docker (Recommended)

This provides a complete Docker-based environment with PostgreSQL database in containers.

Prerequisites for Docker Setup

  1. Docker Desktop - Download here
  2. .NET 8.0 SDK - Download here
  3. Docker Compose (usually included with Docker Desktop)

Quick Start with Docker

For Windows Users

setup-and-run.bat

For Linux/macOS Users

chmod +x setup-and-run.sh
./setup-and-run.sh

What the Docker Setup Does

  1. Stops existing containers - Cleans up any previous running instances
  2. Starts PostgreSQL database - Runs PostgreSQL 16 in a Docker container
  3. Waits for database - Ensures the database is ready before proceeding
  4. Runs migrations - Applies Entity Framework migrations to create the database schema
  5. Starts the web application - Builds and runs the GoodFood web application

Docker Access Points

  • Web Application: http://localhost:8090
  • PostgreSQL Database: localhost:5432
    • Database: goodfood_db_pub
    • Username: postgres
    • Password: 6859
    • Environment: Staging

🛠️ Setup Option 2: Manual (Local Development)

For developers who prefer to run PostgreSQL and the application locally without Docker.

Prerequisites for Manual Setup

  1. .NET 8.0 SDK - Download here
  2. PostgreSQL 12+ - Download here
  3. pgAdmin (optional) - Download here

Required PostgreSQL Databases

You need to create the following database on your local PostgreSQL server:

Database Name Purpose Username Password
goodfood_db_pub Main application database postgres 2385

Quick Start with Manual Setup

For Windows Users

setup-manual.bat

For Linux/macOS Users

chmod +x setup-manual.sh
./setup-manual.sh

Manual Setup Steps (if scripts don't work)

  1. Create the database:

    -- Connect to PostgreSQL as superuser and run:
CREATE DATABASE goodfood_db_pub
    WITH OWNER = postgres
    ENCODING = 'UTF8';

  2. Or use the provided SQL script:

    psql -h localhost -p 5432 -U postgres -f setup-database.sql

  3. Install EF Core tools:

    dotnet tool install --global dotnet-ef

  4. Run database migrations:

    dotnet ef database update --project src/GoodFood.Infrastructure --startup-project src/GoodFood.Web

  5. Run the application:

    cd src/GoodFood.Web
dotnet run

Manual Setup Access Points

🔧 Environment Configuration

The application uses different configurations based on the environment:

Environment Used For Database Host Database Password Port
Development Manual/Local setup localhost 2385 5000/7001
Staging Docker setup db (container) 6859 8090
Production Production deployment localhost 2385 varies

📁 Project Structure

GoodFood/
├── src/
│   ├── GoodFood.Web/           # Main web application
│   ├── GoodFood.Application/   # Application services
│   ├── GoodFood.Domain/        # Domain entities and logic
│   └── GoodFood.Infrastructure/ # Data access and external services
├── tests/                      # Unit and integration tests
├── docker-compose.yml          # Docker configuration
├── setup-and-run.bat/.sh      # Docker setup scripts
├── setup-manual.bat/.sh       # Manual setup scripts
└── setup-database.sql         # Database creation script

🛠️ Development Commands

Common EF Core Commands

# Create a new migration
dotnet ef migrations add MigrationName --project src/GoodFood.Infrastructure --startup-project src/GoodFood.Web

# Update database
dotnet ef database update --project src/GoodFood.Infrastructure --startup-project src/GoodFood.Web

# Remove last migration
dotnet ef migrations remove --project src/GoodFood.Infrastructure --startup-project src/GoodFood.Web

Docker Commands

# Start only database
docker-compose up -d db

# Start everything
docker-compose up --build

# Stop all services
docker-compose down

# Stop and remove all data
docker-compose down -v

# View logs
docker-compose logs webapp
docker-compose logs db

🚨 Troubleshooting

Database Connection Issues

For Docker Setup:

  1. Ensure Docker is running
  2. Check container status: docker ps
  3. Verify database health: docker exec goodfood_db pg_isready -U postgres -d goodfood_db_pub

For Manual Setup:

  1. Ensure PostgreSQL service is running
  2. Verify database exists: psql -h localhost -p 5432 -U postgres -l
  3. Test connection: psql -h localhost -p 5432 -U postgres -d goodfood_db_pub

Migration Issues

  1. Ensure .NET 8.0 SDK is installed: dotnet --version
  2. Verify project builds: dotnet build src/GoodFood.Web/GoodFood.Web.csproj
  3. Check connection strings in appsettings files

Port Conflicts

Docker: Modify ports in docker-compose.yml Manual: The application will use the next available port automatically

📦 Additional Setup Files

  • setup-database.sql - SQL script to create required databases
  • docker-compose.override.yml - Development overrides for Docker
  • Dockerfile - Application container configuration