Creating an Organization Project

In this topic we'll step you through creating an organization project.

To create an organization project using the Todo Grafbase schema perform the following steps. Note that some of the steps might not be necessary if you have already given Grafbase rights to access your GitHub account.

  1. Navigate to your organization dashboard. The URL is typically like the following, where ORGANIZATION is the name of your organization:
  2. Select Create Project.
  3. Select the Todo template.
  4. Select Connect GitHub. Once again we ask permission to use some of your information.
  5. Select Authorize Grafbase.
  6. Select Add an Account.
  7. Select where you want us to install our Grafbase app, which enables us to automatically deploy changes to your repository to our global network.
  8. Select All repositories as the todo repository has not yet been created. Note the list of permissions you are approving.
  9. Select Install.
  10. By default the Create private Git repository option is selected. If you want your repository to be public, unselect this option.
  11. Select Deploy. We 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 the grafbase folder at the root of your repository.

We then redirect 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 switch between the Overview, Playground, Branches, and Settings tabs.

You can also create an organization project from an existing GitHub repository, or by using the Grafbase command-line interface (CLI).

To create an organization project from an existing GitHub repository, see Creating a Project from a GitHub Repository.

To create an organization project using the CLI, see Using the Grafbase CLI. The CLI also offers a local development environment that you can use to quickly test your GraphQL queries and mutations.

Was this page helpful?