TerabyteTiger/gridsome-airtable-starter

A Gridsome starter leveraging Airtable with a minimalist design.

Airtable starter for Gridsome

This starter is meant to act as a starting point/example for connecting Gridsome with Airtable.

Note: This Starter utilizes Moment.js for date/times and can be removed from the Event files if not needed (and removed with yarn remove moment)

Install Gridsome CLI tool (if you dont' have it already)

npm install --global @gridsome/cli

Create a Gridsome project

1. gridsome create my-gridsome-site https://github.com/12vanblart/gridsome-airtable-starter.git to install this starter
2. cd my-gridsome-site to open the folder
3. gridsome develop to start a local dev server at http://localhost:8080
4. Happy coding 🎉💻

Configure your Airtable connection for your first table

Inside your gridsome.config.js file, you'll see the following:

// gridsome.config.js //
module.exports = {
  siteName: "Airtable Starter",
  plugins: [
    {
      use: "@gridsome/source-airtable",
      options: {
        // Add these to a .env file
        // Details on finding these values can be found at:
        // https://gridsome.org/plugins/@gridsome/source-airtable
        apiKey: process.env.AIRTABLE_KEY, //required
        baseId: process.env.AIRTABLE_BASE, //required
        tables: [
          {
            name: "Events",
            typeName: "Event", //required - needs to match template name
            select: {}, //optional
            links: [], //optional
          },
          // Comment in this section and the line in `templates` for multiple tables!
          // {
          //   name: "Parties",
          //   typeName: "Parties", //required - needs to match template name
          //   select: {}, //optional
          //   links: [], //optional
          // },
        ],
      },
    },
  ],
  templates: {
    Event: "/events/:id", //optional
    // Parties: "/parties/:id", //optional
  },
};

• apiKey is the API secret provided by Airtable
• baseId is the identifier for the base you would like to connect to
• tableName is the table you would like to pull data from
• typeName is what you would like to call your data in GraphQL
• route is the optional path you would like to use for accessing your records. This can use GraphQL keys to identify records.

Note: In order for your templates to generate properly at the specified route a typeName.vue file must exist in \templates. In this starter, this is \templates\Event.vue for the Event type.

For connecting multiple tables or using links between tables, see the official plugin's documentation. 😄

dotenv file

Details on Gridsome Environment Variables.

You'll need to create the file .env in your root project directory (The same level as gridsome.config.js) with the following (replace with your values):

AIRTABLE_KEY=<apiKey>
AIRTABLE_BASE=<baseId>

You can learn more about getting these values from the plugin page.

NOTE: When you deploy to Netlify, you'll need to setup these values under "Build & Deploy" > "Environment" > "Environment Variables"

Query Pages

A list of files where the starter uses queries to make updating easier (all from the src folder):

• pages/Events.vue - Grabs all Events sorted by startDate
• components/EventCard.vue - Brings Props in from pages/Events.vue
• templates/Event.vue - Uses id to pull in data from Airtable.

My Airtable

This is what my Airtable Base looks like:

Deploy with Netlify