Dagster Quickstart

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.

Running The Project

Option 1. Using GitHub Codespaces

1. Fork this repository

2. From the Code dropdown, select Create codespace on main

3. Once the codespace has loaded, run dagster dev in the terminal to start Dagster:

   dagster dev

4. When prompted, click Open in Browser.

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.

5. Success! You'll be presented with the lineage of assets in the quickstart project.

Option 2. Running Locally

1. Clone the Dagster Quickstart repository:

   git clone https://github.com/dagster-io/dagster-quickstart
   
   cd dagster-quickstart

2. 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]"

3. Run the project!

   dagster dev

Development

Adding new Python dependencies

You can specify new Python dependencies in setup.py.

Unit testing

Tests are in the dagster_quickstart_tests directory and you can run tests using pytest.

Deploy on Dagster Cloud

The easiest way to deploy your Dagster project is to use Dagster Cloud.

Check out the Dagster Cloud Documentation to learn more.