Skip to content

Commit

Permalink
update setup
Browse files Browse the repository at this point in the history
  • Loading branch information
matsonj committed Sep 22, 2024
1 parent 19d4ba1 commit 46afcae
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions setup-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@ To get started with the tutorial, you'll need a GitHub Codespace. The template c
1. Create a MotherDuck account.
2. Create a database inside of MotherDuck. This can be done with the command `create database {my_database};` from the MotherDuck UI.
3. Fork the [`dbt-tutorial-template`](https://github.com/MotherDuck-Open-Source/dbt-tutorial-template) repo in GitHub.
4. Generate an access token inside of MotherDuck and add it as a codespace secret inside of GitHub.
4. [Generate an access token inside of MotherDuck](https://motherduck.com/docs/key-tasks/authenticating-and-connecting-to-motherduck/authenticating-to-motherduck/#authentication-using-an-access-token) and [add it as a codespace secret inside of GitHub](https://docs.github.com/en/enterprise-cloud@latest/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization#adding-secrets-for-a-repository).
- note: it is important that this token is called `MOTHERDUCK_TOKEN` so that it can be read by the MotherDuck DuckDB extension.
5. Open a codespace on your forked repo.
5. Open a codespace on your forked repo by clicking the big green "code" button your repo.
- note: codespaces do not work on Safari. Use Chrome, Edge or Visual Studio Code.
6. After it loads completely, _reload the window_ in order to make sure the dbt power user extension has access to your md environment.
- python dependencies are added in a post create hook, and a 2-core codespace can be quite slow.
- python dependencies are added in a post create hook, and a 2-core codespace can be quite slow.
7. run `dbt init` to create your dbt project.
8. add this `profiles.yml` file to the root of your dbt project. This will be the folder that create in the previous step.
8. Navigate to your project directory and add this `profiles.yml` file to the root of your dbt project. This will be the folder that create in the previous step.

```yml
# replace "my_project" with the name that matches the project name in step 7.
Expand All @@ -46,6 +47,7 @@ To get started with the tutorial, you'll need a GitHub Codespace. The template c
target: dev
```
9. run `dbt debug` to validate that your setup is correct.
- note: you will need to be in the same directory as your `dbt_project.yml` file.

## Alternative setup

Expand Down

0 comments on commit 46afcae

Please sign in to comment.