Using Grafbase for the first time

This topic will help you get started using your new Grafbase account.

When you initially log into grafbase.com, you should see the overview tab for your personal Grafbase account in your dashboard. You won't have any projects, or belong to any organization, which is why you'll see two links to create a project or create an organization. See the following Creating an Organization and Creating a Project sections for details.

To learn more about organizations and projects, see the Identities and Relationships topic in the Concepts section.

Organizations enable grouping projects together for teams. To create an organization, select Create Organization from the drop-down list next to your account name. Once we've created the organization, you will be the Owner of the organization. As an organization owner, you can create projects within the organization, and add team members to the organization.

Your organization must have a unique name. We create a unique URL for the organization from this name, by converting the name to all lower-case, replacing any spaces with dashes (-), and placing it as a sub-domain within grafbase.com.

For example, if your organization name is "Very Awesome", the URL to it would be https://grafbase.com/very-awesome.

Owners can invite people to join an Organization project as either a Member or an Owner. To add a new person to an Organization project:

  1. Navigate to your organization's dashboard
  2. Select the Settings tab.
  3. Select Members in the left navigation pane
  4. Enter their email address
  5. Select either Member or Owner
  6. Select Invite

Grafbase then sends an invitation to the new member.

Just as you didn't have any organizations when you first joined Grafbase, you do not have any projects at first. Let's remedy that. If you aren't already on the Overview page of your personal account or an organization account, navigate to one of those pages. Note again that you cannot create a team project from a personal account.

  1. Select Create Project
  2. Select either Deploy from Template or Import from Repository

Once you've selected Deploy from Template, perform the following steps to deploy the template, which is a GraphQL schema, to our global network:

  1. Select one of the available templates.
  2. Select or create a GitHub repository to which we add the GraphQL schema from the template. If you create a repository, it takes a moment before it's ready.
  3. Once the repository is ready, select Deploy to Grafbase to deploy the GraphQL schema, and a data store we create for you, to our global network.

As part of the deployment, we copy the GraphQL schema from the template to your GitHub repository as the file schema.graphql in a grafbase folder at the root of your repository.

Your GitHub repository must contain the file schema.graphql in a grafbase folder at the root of your repository.

Once you've selected Import from Repository, perform the following steps to deploy the template to the Grafbase global network:

  1. If you have more than one repository in your GitHub account, select Import next to the repository name in the list.
  2. Confirm the Repository, Production Branch (typically main), and choose a Project Name.
  3. Confirm the schema is correct. If the repository does not contain the file schema.graphql in the grafbase folder at the root of your repository, the Schema pane contains a warning that the file does not exist.
  4. Select Deploy to Grafbase.

Once you've selected Import from Repository, perform the following steps to deploy the GraphQL schema in your repo to our global network:

  • Select one of the repo's branches as the production branch, which is the branch that we make visisble to the public.
  • Select Deploy to Grafbase to deploy the schema, and a data store we create for you, to our global network.

Grafbase them redirects you to your project's dashboard. We recommend that you bookmark that page for easy access.

It will take a minute or so to deploy your schema. Once it's deployed, you can navigate between the Overview, Branches, and Settings tabs to get additional information.

The Overview tab displays metrics about a branch's requests, latency, and deployments. It also includes a link to the branch and displays the last commit message for that branch. If you select the branch name in the top box, we display the latest changes in the branch's schema. If you select the commit message, we display the build log for deploying that schema change.

The Branches tab displays the last commit message for that branch. If you select the branch name in the top box, we display the latest changes in the branch's schema. If you select the commit message, we display the build log for deploying that schema change.

The Settings tab has four sub-tabs:

  • General, which shows the slug/path to the Grafbase project.
  • Git, which shows the name of your GitHub repository under github.com.
  • API Keys, which shows your API keys that you use to access the APIs we create for you to query and mutate your data based on your schema. See the API Keys topic for further information.
  • Danger Zone, where you can delete the project.