graphql-engine/community/sample-apps/gridsome-postgres-graphql/README.md

gridsome-postgres-graphql

Boilerplate to get started with Gridsome, Hasura GraphQL engine as CMS and postgres as database using the awesome plugin source-graphql.

Tutorial

• Deploy GraphQL Engine on Hasura Cloud and setup PostgreSQL via Heroku:

  

• Get the Hasura app URL (say gridsome-graphql.hasura.app)

• Create author table:

  Open Hasura console: visit https://gridsome-graphql.hasura.app on a browser
  Navigate to Data section in the top nav bar and create a table as follows:

  

• Insert sample data into author table:

  

  Verify if the row is inserted successfully

  

• Similarly, create an article table with the following data model: table: article columns: id, title, content, author_id (foreign key to author table's id) and created_at

  

• Now create a relationship from article table to author table by going to the Relationships tab.

• Install Gridsome CLI tool if you don't have

npm install --global @gridsome/cli

• Create a Gridsome project

gridsome create my-gridsome-site

• Go to your project directory

cd my-gridsome-site

• Install node modules:

  yarn install
  

  or npm

  npm install
  

• Configure Gridsome to use source-graphql plugin and a connection GraphQL url to stitch the schema. Open the file gridsome.config.js and modify the plugin section to configure the GraphQL Endpoint.

{
  plugins: [
    {
      use: '@gridsome/source-graphql',
      options: {
        url: 'https://gridsome-graphql.hasura.app/v1/graphql',
        fieldName: 'hasura',
        headers: {
          // Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
        },
      },
    }
  ]
}

• Make a GraphQL query from your component

<template>
  <Layout>
    <h1>Articles</h1>
    <div v-if="$page.hasura.article.length">
        <div class="articles" v-for="article in $page.hasura.article" :key="article.id">
          <p>{{ article.title }} by {{ article.author.name }}</p>
        </div>
    </div>
    <div v-else>
        <p>No articles found</p>
    </div>
  </Layout>
</template>

<page-query>
query {
  hasura {
    article {
      id
      title
      author {
        name
      }
    }
  }
}
</page-query>

• Run the app:

  yarn start
  

• Test the app Visit http://localhost:8080 to view the app

  

Contributing

Checkout the contributing guide for more details.