Skip to content

Latest commit

 

History

History
188 lines (116 loc) · 9.13 KB

README.md

File metadata and controls

188 lines (116 loc) · 9.13 KB
Raw
Flotiq logo

Gatsby starter boilerplate with Flotiq source

Kick off your project with this hello-world boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.

This project use:

  • Flotiq - Headless CMS for string your data (You can create account here)
  • Tailwind - utility-first CSS framework
  • Flotiq source plugin - connector for fetching data from Flotiq
  • Flotiq components for react - components library designed and written to work perfectly with Flotiq Content Objects and display your data beautifully

This project works on node ^14.17.0 || >=16.0.0, we do not support node 15.

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-boilerplate.git
    • flotiqApKey - Read and write API key to your Flotiq account
    • projectName - project name or project path (if you wish to start project in or import data from the current directory - use .)

  2. You can also start the project from template using Gatsby CLI

    gatsby new gatsby-starter-boilerplate https://github.com/flotiq/gatsby-starter-boilerplate.git

  3. Configure application

    The next step is to configure our application to know from where it has to fetch the data.

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

    GATSBY_FLOTIQ_API_KEY=YOUR FLOTIQ API KEY
GA_TRACKING_ID=YOUR GA TRACKING KEY

  4. Start developing.

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

    cd gatsby-starter-boilerplate/
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 data to your account, before running gatsby develop run:

    flotiq import [flotiqApiKey] .

    It will add one example object 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 any content types in your account.

  5. 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 the gatsby-starter-boilerplate directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

  6. Manage your content using Flotiq editor

    You can now easily manage your content using Flotiq editor

Deploy

Deploy this starter with one click on Gatsby Cloud:

Deploy to Gatsby Cloud

You can also deploy this project to Heroku in 3 minutes:

Deploy

Or to Netlify:

Deploy

What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── .flotiq
├── .github
├── node_modules
├─┬ src
│ ├── assets
│ ├── pages
│ └── style
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .prettierignore
├── .prettierrc
├── app.json
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── LICENSE
├── netlify.toml
├── package.json
├── README.md
├── static.json
├── tailwind.config.js
└── yarn.lock

  1. .flotiq: This directory contains content types necessary to starter to work.

  2. .github: This directory contains templates of GitHub issues.

  3. /node_modules: This directory contains all packages that your project depends on (npm packages) and are automatically installed.

  4. /src: This directory will contain all the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

  5. /src/assets: This directory will contain all static assets for the project (images, favicons, custom fonts).

  6. /src/pages: This directory will contain all static pages for the project.

  7. /src/style: This directory will contain global styles for the project.

  8. .eslintignore: This file tells eslint which files it should not track / not fix.

  9. .eslintrc.js: This is a configuration file for Eslint. Eslint is a tool to help keep the formatting of your code consistent automatically.

  10. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  11. .prettierignore: This file tells prettier which files it should not track / not fix.

  12. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

  13. app.json: Configuration file for Heroku deploy. You can safely remove this file if you do not plan to deploy on Heroku.

  14. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  15. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  16. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  17. LICENSE: This Gatsby starter is licensed under the MIT license.

  18. netlify.toml: Configuration file for Netlify deploy. You can safely remove this file if you do not plan to deploy on Netlify.

  19. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc.). This manifest is how npm knows which packages to install for your project.

  20. README.md: A text file containing useful reference information about your project.

  21. static.json: Configuration file for caching the project.

  22. tailwind.config.js: Configuration file for tailwind.

  23. yarn.lock: This is an automatically generated file based on the exact versions of your yarn dependencies that were installed for your project. (You won’t change this file directly).

Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

Learning Flotiq

Full documentation for Flotiq lives on this website.

Documentation for gatsby starters is here.

Collaborating

If you wish 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.