Skip to main content

Baby Tools Shop

Table of Contents​

  1. Project Description
  2. Quickstart
  3. Local Development Usage
  4. Containerized Usage (Docker)
  5. Project Structure
  6. Demo Data Script
  7. Notes on Code Adjustments
  8. License

1. Project Description​

Baby Tools Shop is a demonstration web application built using Django.
It provides:

  • A simple product catalog
  • Category-based product organization
  • Django admin integration
  • Image upload support
  • A clean, educational architecture for learning Django basics

This repository contains the Django project, a Dockerfile for containerization,
docker-compose setup, a Quickstart dataset script, and documentation.

Development happens inside the feature/containerizing branch, while the
main branch remains untouched as the clean fork baseline. All changes are
reviewed through a Pull Request.

2. Quickstart​

This section explains how to run the project locally (without Docker).

Prerequisites​

Before starting, ensure the following tools are installed:

  • Python 3.12+
  • Git
  • Virtual environment (venv)

2.1 Clone the Repository​

Clone the repository and switch into the project directory:

git clone git@github.com:Ozinho78/baby-tools-shop.git
cd baby-tools-shop

2.2 Switch to the feature branch (contains the latest containerization work)​

git switch feature/containerizing

2.3 Setup Virtual Environment​

The virtual environment must be created inside the babyshop_app folder:

Windows (PowerShell)​

cd babyshop_app
python -m venv venv
.\venv\Scripts\activate

Linux / macOS (Bash / Zsh)​

cd babyshop_app
python -m venv venv
source venv/bin/activate

2.4 Install Dependencies​

pip install -r requirements.txt

2.5 Create .env File​

If an example file exists:

Windows​

copy .env.example .env

Linux / macOS​

cp .env.example .env

2.5 Apply Database Migrations​

python manage.py migrate

2.6 Create Superuser​

python manage.py createsuperuser

2.7 Loading Demo Data (without images)​

python create_demo_data.py

2.8 Start Development Server​

python manage.py runserver

The app will be available at: 👉 http://127.0.0.1:8000/

⚠️ Python Compatibility Note (Important)​

This project was originally developed with Python < 3.10. If you use Python 3.12+, some imports in products/models.py must be removed or commented out:

# from distutils.command.upload import upload
# from email.policy import default
# from enum import unique
# from pyexpat import model
# from unicodedata import name

These lines reference deprecated modules that are no longer available in modern Python versions.

3. Local Development Usage​

Once the Quickstart setup is completed, you can continue local development using:

3.1 Run the development server​

python manage.py runserver

3.2 Create or edit models​

Models are located inside the products and babyshop apps. After modifying models, run migrations:

python manage.py makemigrations
python manage.py migrate

3.3 Access Django Admin​

http://127.0.0.1:8000/admin

Use the superuser you created during Quickstart.

3.4 Uploaded images​

Uploaded product images are stored under:

babyshop_app/media/

This folder is automatically created when the first image is uploaded.

4. Containerized Usage (Docker)​

This project includes a full Docker setup consisting of:

  • Dockerfile
  • docker-compose.yml
  • Persistent volumes
  • Automatic migrations
  • Automatic static file collection

This allows the application to run identically on any system without needing a local Python installation.

4.1 Requirements​

To run the containerized version, install:

  • Docker
  • Docker Compose

Verify installation:

docker --version
docker compose version

4.2 Build the container image​

From the repository root:

docker compose build

4.3 Start the application​

docker compose up -d

This will automatically:

  • Apply database migrations
  • Collect static files
  • Start Django inside the container
  • Mount persistent volumes for DB, media, and static files
  • Expose the app on port 8025 of your VM

4.4 Access the application​

The Docker container maps internal port 8000 to external port 8025:

http://<YOUR-SERVER-IP>:8025

Example (local test):

http://127.0.0.1:8025

4.5 Stop the container​

docker compose down

All data remains preserved thanks to Docker volumes.

4.6 View logs​

docker compose logs -f

4.7 Rebuild after code changes​

docker compose down
docker compose build --no-cache
docker compose up -d

4.8 Optional: Generate demo data inside the container​

docker compose exec web python create_demo_data.py

5. Project Structure​

The repository contains the Django application, Docker setup, demo data script, and documentation.
Only relevant files and folders are listed below.

baby-tools-shop/
│
├── docker-compose.yml     # Defines the Django service, volumes, ports, restart policy
├── dockerfile             # Builds the Django application image (Python 3.13 slim)
├── .env                   # Environment variables for Django (DEBUG, SECRET_KEY, HOSTS)
├── README.md              # Documentation, Quickstart, Docker instructions
│
├── babyshop_app/
│   ├── manage.py          # Django management entry point (used by Docker CMD)
│   ├── requirements.txt   # Python package list installed inside the container
│   │
│   ├── babyshop/settings.py   # Central Django configuration (STATIC_ROOT, DEBUG via .env)
│   │
│   └── create_demo_data.py    # Optional script to preload demo categories & products
│
└── project_images/        # Images used in the README only (no runtime relevance)

6. Demo Data Script​

The create_demo_data.py script provides a simple way to populate the database with initial content.

Features​

  • Automatic Django setup via django.setup()
  • Creation of multiple categories
  • Creation of 1–3 products per category
  • Automatic slug generation
  • Randomized pricing
  • Works in both local and Dockerized environments

Running the Script (Local)​

cd babyshop_app
.\venv\Scripts\activate
python create_demo_data.py

Running the Script (Inside Docker)​

docker compose exec web python create_demo_data.py

7. Notes on Code Adjustments​

The file products/models.py originally contained several outdated imports that referenced deprecated Python modules (e.g., distutils).
These modules are no longer available in modern Python versions (Python 3.10+).

The following lines were commented out to restore compatibility with Python 3.12+:

# from distutils.command.upload import upload
# from email.policy import default
# from enum import unique
# from pyexpat import model
# from unicodedata import name

These imports were not used anywhere in the codebase and removing them does not affect application behavior.

This adjustment ensures full compatibility in local development as well as within the Docker container environment.

8. License​

This project is intended for educational use as part of the Baby Tools Shop assignment.
It is based on a provided template and extended with containerization features and documentation.
All rights remain with the original authors of the template project.