Skip to content
This repository has been archived by the owner on Mar 18, 2022. It is now read-only.

flotiq/gatsby-starter-products-with-categories

Repository files navigation

Flotiq logo

Gatsby Starter: Ecommerce and Flotiq, products with categories

This is a Gatsby starter project for ecommerce using Snipcart. It's configured to pull products and categories data from Flotiq and can be easily deployed to your cloud hosting - Heroku, Netlify, Gatsby Cloud, etc.

Live Demo: https://flotiq-products-with-categorie.herokuapp.com

Screenshot

Quick start

  1. Start the project from template using Flotiq CLI

    npm install -g flotiq-cli
    flotiq start [flotiqApiKey] [projectName] https://github.com/flotiq/gatsby-starter-products-with-categories.git
    • flotiqApKey - Read and write API key to your Flotiq account
    • projectName - project name or project path (if you wish to start or import data from the current directory - use .)
  2. You can also start the project from template using Gatsby CLI

    gatsby new gatsby-starter-products-with-categories https://github.com/flotiq/gatsby-starter-products-with-categories.git
  3. Setup "Products" Content Type in Flotiq

Create your Flotiq.com account.

Next, create the Category and the Product Content Type:

Create content type definition using Flotiq Create content type definition using Flotiq

Note: You can also create Category and Product using Flotiq REST API

  1. Configure application

The last step is to configure our application to know from where it has to fetch the data. You can also setup your Snipcart API_KEY to enable store functionality.

You need to create a file called .env inside the root of the directory, with the following structure:

GATSBY_FLOTIQ_API_KEY=YOUR FLOTIQ API KEY
SNIPCART_API_KEY=YOUR SNIPCART PUBLIC API KEY
  1. Start developing.

    Navigate into your new site’s directory and start it up.

    cd gatsby-starter-products-with-categories
    npm install
    gatsby develop

    This step is optional and is not necessary if you used flotiq-cli to start the project.

    If you wish to import example products to your account, before running gatsby develop, install flotiq-cli, and run in project directory:

    flotiq import [flotiqApiKey] .

    It will add 2 categories, 10 images and 4 products to your Flotiq account.

    Note: You need to put your Read and write API key as the flotiqApiKey for import to work. You don't need Category and Product content types in your account. If you already have products with ids product-1, product-2, product-3, and product-4 or categories with ids category-1 and category-2 they will be overwritten.

  2. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open a project directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

  3. Manage your products using Flotiq editor

    You can easily manage your products and categories using Flotiq editor

Deploy

You can deploy this project to Heroku in 3 minutes:

Deploy

Or to Netlify:

Deploy

Collaborating

If you wish to to talk with us about this project, feel free to hop on our Discord Chat.

If you found a bug, please report it in issues.