snhou/jaffle-shop-dbt-demo

The easiest way to run the Jaffle Shop DBT Project.

Medium Link

Prerequisites

1. git
2. Python 3.9 or higher
3. Docker Desktop

Setup environment

1. Clone this repository

$ git clone https://github.com/snhou/jaffle-shop-dbt-demo.git

2. Change into the jaffle_shop directory

$ cd jaffle-shop-dbt-demo

3. Install virtual environment

$ python3 -m venv venv

4. Enter into venv

$ source venv/bin/activate

5. Update pip

$ python3 -m pip install --upgrade pip

6. Install dependencies

$ python3 -m pip install -r requirements.txt

7. Open Docker Desktop and run docker-compose.yaml

$ docker compose build

$ docker compose up -d

Running this project

1. Set up a profiles.yml called jaffle_shop to connect to a data warehouse

jaffle_shop:
  target: dev
  outputs:
    dev:
      type: postgres
      host: localhost
      user: dbt
      password: dbt
      port: 5432
      dbname: dbt
      schema: jaffle-shop-classic
      threads: 4

2. Ensure your profile is setup correctly from the command line:

$ dbt debug

• it will generate a .user.yml file

3. Load the CSVs with the demo data set. This materializes the CSVs as tables in your target schema. Note that a typical dbt project does not require this step since dbt assumes your raw data is already in your warehouse.

$ dbt seed

4. Run the models:

$ dbt run

5. Test the output of the models:

$ dbt test

6. Generate documentation for the project:

$ dbt docs generate

7. View the documentation for the project:

$ dbt docs serve