Skip to content

Running the App ​

There are two ways to run the Dunder Mifflin Package Manager: with Docker (recommended, fewest prerequisites) or directly on your machine using the dev scripts (no Docker required).

The clone URL below uses your fork of package-this from Part 5 — replace <your-username> with your GitHub username. (Already cloned it in Part 5? Just cd into it and start the app.)


Option 1: Docker ​

Prerequisites ​

Steps ​

powershell
git clone https://github.com/<your-username>/package-this.git
cd package-this
docker compose up
bash
git clone https://github.com/<your-username>/package-this.git
cd package-this
docker compose up

That's it. Docker pulls the SQL Server image, builds the backend and frontend, runs migrations, and seeds the database on first start.


Option 2: Dev Script (no Docker) ​

The dev scripts handle virtual environment creation, dependency installation, database migrations, and starting both services. The database defaults to SQLite so no database server is needed.

Prerequisites ​

First run ​

powershell
git clone https://github.com/<your-username>/package-this.git
cd package-this
.\scripts\dev.ps1
bash
git clone https://github.com/<your-username>/package-this.git
cd package-this
chmod +x scripts/dev.sh
./scripts/dev.sh

On first run the script will:

  1. Create a Python 3.12 virtual environment in backend/.venv
  2. Install Python dependencies from backend/requirements.txt
  3. Run database migrations (creates a local backend/dm_packages_dev.db SQLite file)
  4. Install Node dependencies in frontend/node_modules
  5. Start the backend and frontend

On subsequent runs it skips steps 1, 2, and 4 if those outputs already exist.

Stopping the services ​

powershell
# Close the two terminal windows that were opened by dev.ps1,
# or press Ctrl+C in each one.
bash
# Press Ctrl+C in the terminal where dev.sh is running.
# Both backend and frontend are stopped automatically.

Service URLs ​

Once running, all services are available on localhost:

ServiceURL
Frontendhttp://localhost:4200
Backend APIhttp://localhost:8000