Get up-and-running with the Dagster quickstart project -- open the project in a GitHub Codespace and start building data pipelines with no local installation required.
For more information on how to use this project, please reference the Dagster Quickstart guide.
-
Fork this repository
-
From the Code dropdown, select Create codespace on main
![Create codespace](https://private-user-images.githubusercontent.com/5807118/307070696-954493f0-99ac-4aa9-884b-3b2800d2a0d8.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjAzODc5MjEsIm5iZiI6MTcyMDM4NzYyMSwicGF0aCI6Ii81ODA3MTE4LzMwNzA3MDY5Ni05NTQ0OTNmMC05OWFjLTRhYTktODg0Yi0zYjI4MDBkMmEwZDgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDcwNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA3MDdUMjEyNzAxWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZmNiYTMyY2ViOTA2OGUxYjAwZTBmOTM0NzQ5YWFlYTY2ZDBjNjNkMWEyNDA2ZWVjZmFlOTE5NTgzMjlmM2E0YSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.3d5B4DMw_PEnGtJc7bfndZJ75GyRHIK8oqz2SwDKuWE)
-
Once the codespace has loaded, run
dagster dev
in the terminal to start Dagster:dagster dev
-
When prompted, click Open in Browser.
![Codespace Open In Browser](https://private-user-images.githubusercontent.com/5807118/306706984-2d598c56-2bf5-4ffb-927f-5d2e4a5e6967.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjAzODc5MjEsIm5iZiI6MTcyMDM4NzYyMSwicGF0aCI6Ii81ODA3MTE4LzMwNjcwNjk4NC0yZDU5OGM1Ni0yYmY1LTRmZmItOTI3Zi01ZDJlNGE1ZTY5NjcucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDcwNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA3MDdUMjEyNzAxWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NDIzNDJkYTgxOGY2YmNlZjUyOGNhNGY4MzMyNTAwMWQyYzM4ZTkwODBhYWE3NWMxMzQzYjA5OWRiODEyZTdiZiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.GZM_PA_uI3b-S9a3214_PwkXUG6dAdwBdxATxiia2xw)
Tip
If the popup to open Dagster is not visible, you can navigate to the Forwarded Ports tab, and open the Forwarded Address for port 3000.
- Success! You'll be presented with the lineage of assets in the quickstart project.
-
Clone the Dagster Quickstart repository:
git clone https://github.com/dagster-io/dagster-quickstart cd dagster-quickstart
-
Install the required dependencies.
Here we are using
-e
, for "editable mode", so that when Dagster code is modified, the changes automatically apply.pip install -e ".[dev]"
-
Run the project!
dagster dev
You can specify new Python dependencies in setup.py
.
Tests are in the dagster_quickstart_tests
directory and you can run tests using pytest
.
The easiest way to deploy your Dagster project is to use Dagster Cloud.
Check out the Dagster Cloud Documentation to learn more.