Skip to content

Latest commit

 

History

History

with-fauna

README.md

StepZen Example: with-fauna

Introduction

This project builds a GraphQL API that composes data from Fauna and GitHub, by combining the Fauna GraphQL API with the GitHub GraphQL API.

Getting Started

You'll need to create a StepZen account first.

Alternatively, you can login using stepzen login --public without signing up, but note that your API will be publicly accessible.

Once you've got that set up, git clone this repository onto your machine and open the working directory:

git clone https://github.com/stepzen-dev/examples.git
cd examples/with-fauna

Before running this example, you need to set up a Fauna instance and retrieve your GitHub personal access token.

Set up Fauna

To use Fauna, you should complete the set up instructions for GraphQL and upload the following GraphQL schema:

type Highlight {
  repository: Repository! @relation
}

type Repository {
  owner: String!
  name: String!
  coverImage: String
  shortDescription: String
}

type Query {
  highlights: [Highlight]!
  repositories: [Repository]!
}

And get your Fauna GraphQL endpoint URL and API key from the Fauna dashboard. See here for more information on how to get your endpoint URL and API key.

Get a GitHub personal access token

To use the GitHub GraphQL API, you'll need to create a personal access token with the repo scope.

Run StepZen

Open your terminal and install the StepZen CLI. You need to login here using the command: stepzen login.

You can copy the file sample.config.yaml to a new config.yaml file:

cp sample.config.yaml config.yaml

And enter your credentials from Fauna and GitHub into the config.yaml file:

configurationset:
  - configuration:
      name: fauna
      authorization: Basic YOUR_API_KEY
  - configuration:
      name: github
      authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN

If your Fauna endpoint is not https://graphql.us.fauna.com/graphql please update all references to it in the graphql-01/index.graphql file.

Start the GraphQL by running stepzen start. After you've followed the prompts (you can accept the suggested endpoint name or add your own), a proxy of the GraphiQL playground becomes available at http://localhost/5001 (in example http://localhost:5001/api/with-fauna), which you can use to explore the GraphQL API. Also, the endpoint at which your GraphQL API is deployed gets logged in the terminal. You can query your GraphQL API from any application, browser, or IDE by providing the API Key linked to your account.

Learn More

You can learn more in the StepZen documentation. Questions? Head over to Discord or GitHub Discussions to ask questions.