Skip to content

Update quickstart.mdx #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 4, 2025
Merged

Update quickstart.mdx #195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 2 additions & 75 deletions dgraph/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check failure on line 1 in dgraph/quickstart.mdx

View workflow job for this annotation

GitHub Actions / Trunk Check

prettier 

Incorrect formatting, autoformat by running 'trunk fmt'
title: Quickstart
"og:title": "Quickstart - Dgraph"
---
Expand All @@ -20,82 +20,12 @@

## Run Dgraph and connect the Ratel web UI

The easiest way to get Dgraph up and running in the cloud is using
[Dgraph on Hypermode](https://hypermode.com/login). If you prefer a local
development experience with Dgraph we recommend using the official Dgraph Docker
image. Both options are described below.
The recommended way to get started with Dgraph for local development is by using the official Dgraph Docker image.

Check notice on line 23 in dgraph/quickstart.mdx

View workflow job for this annotation

GitHub Actions / Trunk Check

markdownlint(MD009) 

[new] Trailing spaces

In this section we'll create a new graph, then we'll connect our new graph to
[Ratel](./glossary#ratel), the web-based UI for Dgraph.

<Tabs>
<Tab title="On Hypermode">
<Steps>
<Step title="Sign in to Hypermode and create your workspace">

Open [`hypermode.com/login`](https://hypermode.com/login) in your web browser and sign
in to Hypermode to create your account.

After signing in you'll be prompted to choose a name for your workspace.

![Create your Hypermode workspace](/images/dgraph/quickstart/create-workspace.png)

Enter a name for your workspace and then select **Create workspace**.

</Step>

<Step title="Create your graph">

After creating your Hypermode workspace you'll be prompted to create your first
graph.

![Create your first Hypermode graph](/images/dgraph/quickstart/create-graph-2.png)

Enter a name for your graph and choose the hosting location, then select
**Create graph**.

</Step>

<Step title="View your graph details">

Once your graph is created you'll see the graph details including its status,
connection string, and API key.

![Graph detail view](/images/dgraph/quickstart/graph-details.png)

We'll use the Dgraph connection string and the API key to connect to our graph
via Dgraph clients such as Ratel or language SDKs.

Click on the copy icon next to the connection string to copy the Dgraph
connection string.

</Step>

<Step title="Connect the Ratel graph client">

Ratel is a web-based Dgraph client for interacting with your graph. We'll use
Ratel to execute DQL queries and update the graph schema.

Navigate to [ratel.hypermode.com](https://ratel.hypermode.com) and paste the
Dgraph connection string you copied in the previous step into the "Dgraph Conn
String" text box in Ratel then select **Connect** to verify the connection and
then select **Continue** to access the Ratel console.

![Connecting to Ratel](/images/dgraph/quickstart/ratel-connection-string.png)

The Ratel console is where we can execute DQL queries and mutations and view the
results of these operations, including visualizing graph data.

![Ratel overview](/images/dgraph/quickstart/ratel-overview.png)

Now we're ready to add data to our graph.

</Step>

</Steps>
</Tab>

<Tab title="Locally"><Steps>
<Steps>
<Step title="Run Dgraph with Docker">
The [`dgraph/standalone`](https://hub.docker.com/r/dgraph/standalone) Docker image has everything needed to run Dgraph locally.

Expand Down Expand Up @@ -139,9 +69,6 @@
</Step>
</Steps>

</Tab>
</Tabs>

## Add data to the graph with a mutation

Graph databases like Dgraph use a data model called the **property graph**,
Expand Down
Loading