Skip to content

dgraph-io/tour

Repository files navigation

A Tour of Dgraph

A step-by-step introductory tutorial for Dgraph, the distributed graph database.

Taking the Tour

Prerequisites

macOS / Linux

git clone https://github.com/dgraph-io/tour.git
cd tour
make start

The tour opens automatically in your default browser.

Windows

git clone https://github.com/dgraph-io/tour.git
cd tour
docker compose up -d

Then open http://localhost:1313/ in your browser.

Stopping the Tour

macOS / Linux:

make stop

Windows:

docker compose down

Local Services

Service URL Description
Tour site http://localhost:1313/ The tutorial
Dgraph Alpha http://localhost:8080/ GraphQL and DQL endpoints
Ratel UI http://localhost:8000/ Dgraph query interface

Development

Prerequisites

  • Docker
  • make (pre-installed on macOS and most Linux distributions)

Available Commands

Command Description
make start Start the tour (Dgraph + Hugo + sample data)
make stop Stop the tour
make restart Drop all data and restart the tour
make clean Drop all data, stop containers, and remove images
make test Run all tests (DQL + GraphQL + dataset)
make seed-basic-facets Load facet sample data for the facets lesson
make dev-setup Install dev dependencies (Hugo, linters)
make dev-start Start Hugo dev server with hot reload
make dev-stop Stop Hugo server and Docker containers
make dev-restart Restart dev environment

Run make help for the full list of targets.

Testing

make test

The test suite runs:

  • DQL query tests (42 tests)
  • GraphQL query tests (33 tests)
  • Movie dataset relationship tests (5 tests)

Running the Tour

The tour is no longer hosted as a live site. Clone the repository and run it locally with make start or docker compose up -d as described above.

About

A Tour of Dgraph

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors