Giter Club home page Giter Club logo

jaffle-shop's Introduction

Jaffle

๐Ÿฅช 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

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

    Click 'Use this template'

  2. Follow the steps to create a new repository.

Platform setup

dbt Cloud IDE (most beginner friendly)

  1. 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.

  2. Choose the repo you created in Step 1 as the repository for your dbt Project code.

  3. 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.

  1. Run git clone [new repo name] to clone your new repo to your local machine.

  2. 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
  3. 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
  4. 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).

  5. 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.

  1. Run task setup.

OR

  1. Run dbt build to load the sample data into your raw schema, build your models, and test your project.

  2. Delete the jaffle-data directory now that the raw data is loaded into the warehouse.

Have fun exploring dbt! ๐ŸŽ‰

jaffle-shop's People

Contributors

tyama711 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.