Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jasonbahl/contentful-demo

Gatsby starter for a Contentful project.
https://github.com/jasonbahl/contentful-demo

Last synced: 20 days ago
JSON representation

Gatsby starter for a Contentful project.

Awesome Lists containing this project

README 

        
# gatsby-contentful-starter



Gatsby [Contentful](https://www.contentful.com) starter for creating a blog



![The index page of the starter blog](https://rawgit.com/contentful-userland/gatsby-contentful-starter/master/screenshot.jpg "The index page of the starter blog")



Static sites are scalable, secure and have very little required maintenance. They come with a drawback though. Not everybody feels good editing files, building a project and uploading it somewhere. This is where Contentful comes into play.



With Contentful and Gatsby you can connect your favorite static site generator with an API that provides an easy to use interface for people writing content and automate the publishing using services like [Travis CI](https://travis-ci.org/) or [Netlify](https://www.netlify.com/).



## Features



* Simple content model and structure. Easy to adjust to your needs.

* Contentful integration using our [Sync API](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization/initial-synchronization-of-entries-of-a-specific-content-type)

* Using our [Delivery API](https://www.contentful.com/developers/docs/references/content-delivery-api/).

* Responsive/adaptive images via [gatsby-image](https://www.gatsbyjs.org/packages/gatsby-image/)



## Contribution



This project is part of [contentful-userland](https://github.com/contentful-userland) which means that we’re always open to contributions **and you can be part of userland and shape the project yourself after your first merged pull request**. You can learn more about how contentful userland is organized by visiting [our about repository](https://github.com/contentful-userland/about).



## Requirements



To use this project you have to have a Contentful account. If you don't have one yet you can register at [www.contentful.com/sign-up](https://www.contentful.com/sign-up/).



## Getting started



Install [Yarn](https://yarnpkg.com/en/docs/install) (if you haven't already).



### Get the source code and install dependencies.



```

$ git clone [email protected]:contentful-userland/gatsby-contentful-starter.git

$ yarn install

```



Or use the [Gatsby CLI](https://www.npmjs.com/package/gatsby-cli).



```

$ gatsby new contentful-starter https://github.com/contentful-userland/gatsby-contentful-starter

```



### Set up of the needed content model and create a configuration file



This project comes with a Contentful setup command `yarn run setup`.



![Command line dialog of the yarn run setup command](https://rawgit.com/contentful-userland/gatsby-contentful-starter/master/setup.jpg "Command line dialog of the yarn run setup command")



This command will ask you for a space ID, and access tokens for the Contentful Management and Delivery API and then import the needed content model into the space you define and write a config file (`./contentful.json`).



`yarn run setup` automates that for you but if you want to do it yourself rename `.contentful.json.sample` to `.contentful.json` and add your configuration in this file.



## Crucial Commands



This project comes with a few handy commands for linting and code fixing. The most important ones are the ones to develop and ship code. You can find the most important commands below.



### `yarn run dev`



Run in the project locally.



### `yarn run build`



Run a production build into `./public`. The result is ready to be put on any static hosting you prefer.



### `yarn run deploy`



Run a production build into `./public` and publish the site to GitHub pages.



### `yarn run cleanup-repository`



Removes all dependencies, scripts and data from the installation script.



## Roadmap



- [x] [make the starter completely responsive](https://github.com/contentful-userland/gatsby-contentful-starter/issues/2)

- [ ] [include tags](https://github.com/contentful-userland/gatsby-contentful-starter/issues/3)

- [x] [support traced placeholders](https://github.com/contentful-userland/gatsby-contentful-starter/issues/4)

- [ ] [add i18n](https://github.com/contentful-userland/gatsby-contentful-starter/issues/6)



## Other resources



- Tutorial video series ["Building a blazing fast website with GatsbyJS and Contentful"](https://www.youtube.com/watch?v=Ek4o40w1tH4&list=PL8KiuH6vpACV-F7jXribe4YveGBhBeG9A) by @Khaledgarbaya