Creating a Project from a GitHub Repository

You can create a project from an existing GitHub repository as a personal project or as an organization project. The main difference between the two types of projects is that you can add members to an organization project, whereas you are the only member of a personal project.

To create a project using an existing GitHub repository:

  1. Navigate to your personal Dashboard, with a URL like https://grafbase.com/USER, where USER is your Grafbase user name to create a personal project.
    OR
    Navigate to your organization's Dashboard, with a URL like https://grafbase.com/ORGANIZATION, where ORGANIZATION is the name of your organization, to create an organization project.
  2. Select the Create Project button.
  3. Under the Import Repository section on the left side of the page, select the Import button next to the repository name.
    If the repository does not have a schema.graphql file in the grafbase sub-directory of the repository, the command fails.
    Otherwise, the dashboard displays the schema.graphql file.
  4. Select Deploy.
    We'll deploy your project across our global network and create queries and mutations from your schema.

After a few seconds, we display the following information about your project:

  • Your API keys, which you can use to provide unlimited access to your queries and mutations.
  • The endpoint of your project, which is the GraphQL endpoint for querying and mutating your project data.
  • A link to the Playground, where you can try out your queries and mutations.