https://github.com/jinksi/netlify-cms-react-starter

A starter project for creating lightning-fast, offline-first websites with Netlify-CMS and React
https://github.com/jinksi/netlify-cms-react-starter

netlify netlify-cms react starter static-site static-site-generator

Last synced: 5 months ago
JSON representation

A starter project for creating lightning-fast, offline-first websites with Netlify-CMS and React

• Host: GitHub
• URL: https://github.com/jinksi/netlify-cms-react-starter
• Owner: Jinksi
• License: mit
• Created: 2017-11-18T02:48:34.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-11-06T22:25:28.000Z (over 2 years ago)
• Last Synced: 2023-03-07T13:29:03.908Z (about 2 years ago)
• Topics: netlify, netlify-cms, react, starter, static-site, static-site-generator
• Language: JavaScript
• Homepage: https://netlify-cms-react-starter.netlify.com
• Size: 7.37 MB
• Stars: 94
• Watchers: 2
• Forks: 26
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Netlify CMS + React Starter

> **Warning**

> Netlify CMS is no longer being maintained, therefore I won't be maintaining this project.  

> See https://github.com/netlify/netlify-cms/discussions/6503.  

> Both Netlify CMS and this project both work for the most part (as of Nov 2022), albeit with some outdated approaches e,g, React class components.  

[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![dependencies](https://david-dm.org/jinksi/netlify-cms-react-starter.svg?style=flat-square)](https://david-dm.org/jinksi/netlify-cms-react-starter)

[![Netlify Status](https://api.netlify.com/api/v1/badges/f007e81b-b83b-4433-bd6d-a3924fae3204/deploy-status)](https://app.netlify.com/sites/netlify-cms-react-starter/deploys)

A starter project for creating lightning-fast, offline-first websites with [Netlify CMS](https://netlifycms.org) and React.

- **[Create React App](https://github.com/facebookincubator/create-react-app)**

- **[React Router](https://github.com/ReactTraining/react-router)** for routing

- **[React Helmet](https://github.com/nfl/react-helmet)** for document titles, descriptions, meta

- **[React Snapshot](https://github.com/geelen/react-snapshot)** for pre-rendering to static html so it works without Javascript ⭐️

- **[Netlify CMS](https://github.com/netlify/netlify-cms)** for content management

I aim to include commonly used components and best-practices e.g. forms, settings,  tags, lazy-loading images, etc.

## Get going

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/Jinksi/netlify-cms-react-starter&stack=cms)

1.  Hit the **Deploy to Netlify** button. This will:

- Clone the repo into your Github account

- Create you a new project on Netlify, build & deploy

1.  Once your Netlify project has been created, check a couple of settings:

- Enable **Identity**

- Change **Registration Preferences** to **Invite Only**

- Enable **Git Gateway**

1.  Invite users (probably yourself) to enable admin access

- Open the **Identity** tab and hit **Invite Users**

## Show me the CMS!

The CMS lives at [\_\_YOUR_SITE_NAME\_\_.netlify.com/admin](https://__YOUR_SITE_NAME__.netlify.com/admin).

## Developing

1.  Clone your repo to your local machine

1.  Install dependencies

`yarn` or `npm install`

1.  Run the development server

`yarn start` or `npm run start`

If you are adding or editing content locally in the CMS, a couple of things to note:

1.  Changes will be pushed to the remote repo.

1.  You will be prompted to enter your site's url, this is necessary for Netlify Identity to manage user login. This is stored in `localStorage`, so you might have to empty your browser cache if you are switching projects but remaining on `localhost:3000`.

## Editing CMS fields

The Netlify CMS configuration is located in `public/admin/config.yml`. This is where you will configure the pages, fields, posts and settings that are editable by the CMS.

Find out more in the [Netlify CMS Docs](https://www.netlifycms.org/docs/#configuration).

## See also

[Netlify CMS Docs](https://www.netlifycms.org/docs/)  

[Netlify CMS Repo](https://github.com/netlify/netlify-cms)  

[Hyperstatic](https://github.com/Jinksi/hyperstatic) – the same starter project minus Netlify CMS  

[Gatsby + Netlify CMS Starter (Gatsbro)](https://github.com/Jinksi/gatsbro)