Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decaporg/gatsby-starter-decap-cms
Example Gatsby + Decap CMS project
https://github.com/decaporg/gatsby-starter-decap-cms
bulma cms decap decap-cms gatsby gatsby-netlify-cms jamstack netlify netlify-cms purgecss react starter starter-template static-site-generator
Last synced: about 1 month ago
JSON representation
Example Gatsby + Decap CMS project
- Host: GitHub
- URL: https://github.com/decaporg/gatsby-starter-decap-cms
- Owner: decaporg
- License: mit
- Created: 2017-08-15T23:15:14.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T00:52:00.000Z (7 months ago)
- Last Synced: 2024-05-23T07:05:34.862Z (6 months ago)
- Topics: bulma, cms, decap, decap-cms, gatsby, gatsby-netlify-cms, jamstack, netlify, netlify-cms, purgecss, react, starter, starter-template, static-site-generator
- Language: JavaScript
- Homepage: https://gatsby-netlify-cms.netlify.app/
- Size: 25 MB
- Stars: 2,057
- Watchers: 42
- Forks: 986
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-bulma - gatsby-starter-netlify-cms - Gatsby + Netlify CMS Starter with Bulma (Resources / Starters)
- jimsghstars - decaporg/gatsby-starter-decap-cms - Example Gatsby + Decap CMS project (JavaScript)
README
# Gatsby + Decap CMS Starter
[](https://app.netlify.com/sites/gatsby-starter-netlify-cms-ci/deploys)
**Note:** This starter uses [Gatsby v4](https://www.gatsbyjs.com/gatsby-4/).
This repo contains an example business website that is built with [Gatsby](https://www.gatsbyjs.org/), and [Decap CMS](https://www.decapcms.org): **[Demo Link](https://gatsby-netlify-cms.netlify.com/)**.
It follows the [JAMstack architecture](https://jamstack.org) by using Git as a single source of truth, and [Netlify](https://www.netlify.com) for continuous deployment, and CDN distribution.
## Features
- A simple landing page with blog functionality built with Decap CMS
- Editable Pages: Landing, About, Product, Blog-Collection and Contact page with Netlify Form support
- Create Blog posts from decap CMS
- Tags: Separate page for posts under each tag
- Basic directory organization
- Uses Bulma for styling, but size is reduced by `gatsy-plugin-purgecss`
- Blazing fast loading times thanks to pre-rendered HTML and automatic chunk loading of JS files
- Uses `gatsby-plugin-image` with Decap CMS preview support
- Separate components for everything
- Netlify deploy configuration
- Netlify function support, see `netlify/functions` folder
- Perfect score on Lighthouse for SEO, Accessibility and Performance (wip:PWA)
- ..and more
## Prerequisites
- Minimal Node.js version 14.15.0
- [Gatsby CLI](https://www.gatsbyjs.com/docs/reference/gatsby-cli/)
- [Netlify CLI](https://github.com/netlify/cli)
## Getting Started (Recommended)
Decap CMS can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify. The example here is the Kaldi coffee company template (adapted from [One Click Hugo CMS](https://github.com/decaporg/one-click-hugo-cms)). Use the button below to build and deploy your own copy of the repository:
After clicking that button, you’ll authenticate with GitHub and choose a repository name. Netlify will then automatically create a repository in your GitHub account with a copy of the files from the template. Next, it will build and deploy the new site on Netlify, bringing you to the site dashboard when the build is complete. Next, you’ll need to set up Netlify’s Identity service to authorize users to log in to the CMS.
### Access Locally
Pulldown a local copy of the Github repository Netlify created for you, with the name you specified in the previous step
```
$ git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git
$ cd [REPO_NAME]
$ yarn
$ netlify dev # or ntl dev
```
This uses [Netlify Dev](https://www.netlify.com/products/dev/?utm_source=blog&utm_medium=netlifycms&utm_campaign=devex) CLI feature to serve any functions you have in the `netlify/functions` folder.
To test the CMS locally, you'll need to run a production build of the site:
```
$ npm run build
$ netlify dev # or ntl dev
```
### Media Libraries (installed, but optional)
Media Libraries have been included in this starter as a default. If you are not planning to use `Uploadcare` or `Cloudinary` in your project, you **can** remove them from module import and registration in `src/cms/cms.js`. Here is an example of the lines to comment or remove them your project.
```javascript
import CMS from "decap-cms-app";
// import uploadcare from 'decap-cms-media-library-uploadcare'
// import cloudinary from 'decap-cms-media-library-cloudinary'
import AboutPagePreview from "./preview-templates/AboutPagePreview";
import BlogPostPreview from "./preview-templates/BlogPostPreview";
import ProductPagePreview from "./preview-templates/ProductPagePreview";
import IndexPagePreview from "./preview-templates/IndexPagePreview";
// CMS.registerMediaLibrary(uploadcare);
// CMS.registerMediaLibrary(cloudinary);
CMS.registerPreviewTemplate("index", IndexPagePreview);
CMS.registerPreviewTemplate("about", AboutPagePreview);
CMS.registerPreviewTemplate("products", ProductPagePreview);
CMS.registerPreviewTemplate("blog", BlogPostPreview);
```
Note: Don't forget to also remove them from `package.json` and `yarn.lock` / `package-lock.json` using `yarn` or `npm`. During the build decap-cms-app will bundle the media libraries as well, having them removed will save you build time.
Example:
```
yarn remove decap-cms-media-library-uploadcare
```
OR
```
yarn remove decap-cms-media-library-cloudinary
```
## Getting Started (Without Netlify)
```
$ gatsby new [SITE_DIRECTORY_NAME] https://github.com/decaporg/gatsby-starter-decap-cms/
$ cd [SITE_DIRECTORY_NAME]
$ npm run build
$ npm run start
```
### Setting up the CMS
Follow the [Decap CMS Quick Start Guide](https://www.netlifycms.org/docs/quick-start/#authentication) to set up authentication, and hosting for production.
If you want use Decap CMS locally, run the site in one terminal with `npm run start` and in another
Terminal you can use `npx netlify-cms-proxy-server` which proxy requests so you'll be automatically logged
in as a user on [http:localhost:3000/admin](http:localhost:3000/admin).
## Debugging
Windows users, who aren't using [WSL](https://docs.microsoft.com/en-us/windows/wsl/about), might encounter `node-gyp` errors when trying to npm install.
To resolve, make sure that you have both Python 2.7 and the Visual C++ build environment installed.
```
npm config set python python2.7
npm install --global --production windows-build-tools
```
[Full details here](https://www.npmjs.com/package/node-gyp "NPM node-gyp page").
MacOS and WSL users who might also encounter some errors, check [node-gyp](https://github.com/nodejs/node-gyp) for more info. We recommend using the latest stable node version.
## Purgecss
This plugin uses [gatsby-plugin-purgecss](https://www.gatsbyjs.org/packages/gatsby-plugin-purgecss/) and [bulma](https://bulma.io/). The bulma builds are usually ~170K but reduced 90% by purgecss.
# CONTRIBUTING
Contributions are always welcome, no matter how large or small. Before contributing,
please read the [code of conduct](CODE_OF_CONDUCT.md).