Barcadia is a GatsbyJS starter theme that uses Contentful for content management. It includes the main configuration files found in Gatsby.
-
Create a Gatsby site.
Use the Gatsby CLI to create a new site, specifying the Barcadia starter.
# create a new Gatsby site using the barcadia starter gatsby new my-barcadia-starter https://github.com/bagseye/barcadia
-
Before running Gatsby Develop
You'll need to setup a free account with Contentful Here and create a space ID and access token for your new site.
Once these are generated create a new file in the site root called
.env.development
and populate it with the following information:CONTENTFUL_SPACE_ID={YOUR SPACE ID} CONTENTFUL_ACCESS_TOKEN={YOUR ACCESS TOKEN}
NOTE - Ensure this file has been added to your
.gitignore
to prevent it from being tracked -
Start developing.
Navigate into your new siteβs directory and start it up.
cd my-barcadia-starter/ gatsby develop
-
Import Content-model.json on Contentful Make a Json file(e.g. example-config.json) with the following content.
{ "spaceId": "SPACE_ID", "managementToken": "Generate a management token from the APIs Tab on contentful dashboard", "contentFile": "content-model.json" }
Important Note: you need contentful globally installed(
npm i -g contentful-cli
) before the next step Then Run this Command from your terminal:contentful space import --config example-config.json
-
Open your site
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
my-barcadia-starter
directory in your code editor of choice and editsrc/pages/index.js
. Save your changes and the browser will update in real time! -
Build your site
When you are ready to build your production site, you will need to create a
.env.production
file that will contain theCONTENTFUL_SPACE_ID
andCONTENTFUL_ACCESS_TOKEN
environment variables. After that is set up, you can runnpm run build
orgatsby build
and Gatsby will build your site.
Follow the steps for importing data with Contentful [Here](https://www.contentful.com/developers/docs/tutorials/cli/import-and-export) using the example file `content-model.json`, found in the site root.
A quick look at the top-level files and directories . βββ node_modules βββ src βββ .gitignore βββ .prettierignore βββ .prettierrc βββ content-model.json βββ gatsby-config.js βββ gatsby-node.js βββ LICENSE βββ package-lock.json βββ package.json βββ README.md
-
/node_modules
: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. -
/src
: This directory will contain all of 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β. -
.gitignore
: This file tells git which files it should not track / not maintain a version history for. -
.prettierrc
: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent. -
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. -
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). -
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. -
gatsby-ssr.js
: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering. -
LICENSE
: Gatsby is licensed under the MIT license. -
package-lock.json
(Seepackage.json
below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You wonβt change this file directly). -
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. -
README.md
: A text file containing useful reference information about your project.
Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:
-
For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
-
To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.
Ales Nesetril Josh Rose Cat Han Martin Sanchez Onur Binay Torsten Dettlaff Nick Demou Little John