🥪 The Jaffle Shop 🦘

This is a sandbox project for exploring the basic functionality and latest features of dbt. It's based on a fictional restaurant called the Jaffle Shop that serves jaffles. Enjoy!

Create new repo from template

Click the green "Use this template" button at the top of the page to create a new repository from this template.
Follow the steps to create a new repository.

Platform setup

dbt Cloud IDE (most beginner friendly)

Set up a dbt Cloud account and follow Step 4 in the Quickstart instructions for your data platform, to connect your platform to dbt Cloud.
Choose the repo you created in Step 1 as the repository for your dbt Project code.
Click Develop in the top nav, you should be prompted to run a dbt deps, which you should do.

dbt Cloud CLI (if you prefer to work locally)

If you'd like to use the dbt Cloud CLI, but are a little intimidated by the terminal, we've included a task runner called, fittingly, task. It's a simple way to run the commands you need to get started with dbt. You can install it by following the instructions here. We'll call out the task based alternative to each command below.

Run git clone [new repo name] to clone your new repo to your local machine.
Set up a virtual environment and activate it. I like to call my virtual environment .venv and add it to my .gitignore file (we've already done this if you name your virtual environment '.venv') so that I don't accidentally commit it to the repository, but you can call it whatever you want.
```
python3 -m venv .venv # create a virtual environment
OR
task venv # create a virtual environment

source .venv/bin/activate # activate the virtual environment
```

Install the project's requirements into your virtual environment.

python3 -m pip install -r requirements.txt # install the project's requirements
OR
task install # install the project's requirements

Follow steps 2 and 3 on this page to setup dbt Cloud CLI's connection to dbt Cloud, only if you haven't already done so (we handled step 1 above and will do step 4 together next).
Double check that your dbt_project.yml is set up correctly by running dbt list. You should get back a list of models and tests in your project.

Project setup

Once your development platform of choice is set up, use the following steps to get the project ready for whatever you'd like to do with it.

Run task setup.

OR

Run dbt build to load the sample data into your raw schema, build your models, and test your project.
Delete the jaffle-data directory now that the raw data is loaded into the warehouse. It will be loaded into a raw_jaffle_shop schema in your warehouse. That both dev and prod targets are set up to use. Take a look at the generate_schema_name macro in the macros directory to if you're curious how this is done.

Pre-commit and linting with SQLFluff

This project uses a tool called pre-commit to automatically run a suite of of processes on your code, like linters and formatters, when you commit. If it finds an issue and updates a file, you'll need to stage the changes and commit them again (the first commit will not have gone through because pre-commit found and fixed an issue). The outcome of this is that your code will be more consistent automatically, and everybody's changes will be running through the same set of processes. We recommend it for any project. You can see the configuration for pre-commit in the .pre-commit-config.yaml file. You can run the checks manually with pre-commit run --all-files to see what it does without making a commit.

The most important pre-commit hook that runs in this project is SQLFluff, which will lint your SQL code. It's configured with the .sqlfluff file in the root of the project. You can also run this manually, either to lint your code or to fix it automatically (which also functions loosely as a fairly relaxed formatter), with sqlfluff lint and sqlfluff fix respectively, but if you don't, it will still run whenever you commit to ensure the committed code is consistent.

SQLFluff offers a few different templating options to deal with Jinja in SQL, this project uses the dbt templater, which actually compiles your code with your dbt Core, to ensure maximum correctness. While dbt Cloud does not make use of a profiles.yml, dbt Core does, to define how it connects to your warehouse. Therefore, this project needs a profiles.yml file for SQLFluff to run. We've included a functioning profiles.yml file in the project, as well as a heavily commented profiles-example.yml for you to fill out and replace it with. Make sure to do this if you want to run SQLFluff. If you don't, you can remove the .sqlfluff and .sqlfluffignore files and the sqlfluff commands from the .pre-commit-config.yaml file to get rid of these checks. The same is true for any other pre-commit hooks you don't want to run.

wrgoldstein/jaffle-shop