GraphQL Starter

This starter shows how you can build a GraphQL server with Encore, implementing a basic url shortener as an example.

Prerequisites

Install Encore:

  • macOS: brew install encoredev/tap/encore
  • Linux: curl -L https://encore.dev/install.sh | bash
  • Windows: iwr https://encore.dev/install.ps1 | iex

Docker:

  1. Install Docker
  2. Start Docker

Create app

Create a local app from this template:

encore app create my-app-name --example=graphql

Run app locally

Before running your application, make sure you have Docker installed and running. Then run this command from your application's root folder:

encore run

While encore run is running, open http://localhost:9400/ to view Encore's local developer dashboard.

View the GraphQL Playground

Open http://localhost:4000/graphql/playground in your browser.

Using the API

Execute the below queries using the GraphQL Playground (or method of your choice).

Shorten a URL

mutation {
  shorten(url: "https://encore.dev") {
    id
    url
  }
}

Listing all shortened URLs

query {
  urls {
    id
    url
  }
}

Getting a URL from a shortened ID

query {
  get(id: "some-id") {  # Use an actual ID you have
    id
    url
  }
}

Deployment

Self-hosting

See the self-hosting instructions for how to use encore build docker to create a Docker image and configure it.

Encore Cloud Platform

Deploy your application to a free staging environment in Encore's development cloud using git push encore:

git add -A .
git commit -m 'Commit message'
git push encore

You can also open your app in the Cloud Dashboard to integrate with GitHub, or connect your AWS/GCP account, enabling Encore to automatically handle cloud deployments for you.

Follow these steps to link your app to GitHub:

  1. Create a GitHub repo, commit and push the app.
  2. Open your app in the Cloud Dashboard.
  3. Go to Settings ➔ GitHub and click on Link app to GitHub to link your app to GitHub and select the repo you just created.
  4. To configure Encore to automatically trigger deploys when you push to a specific branch name, go to the Overview page for your intended environment. Click on Settings and then in the section Branch Push configure the Branch name and hit Save.
  5. Commit and push a change to GitHub to trigger a deploy.

Learn more in the docs

Testing

encore test ./...