No description

Find a file

Eric Jinks 8a569af649 <BackgroundImage /> imageSize prop		2018-04-26 15:35:48 +10:00
content	Add responsive iframe support to markdown renderer	2018-04-18 14:47:28 +10:00
functions	Generate Sitemap	2018-02-09 09:56:30 +10:00
public	Upgrade netlify-cms@1.7.0	2018-04-26 08:42:59 +10:00
src	<BackgroundImage /> imageSize prop	2018-04-26 15:35:48 +10:00
.env	Add .env with site url override	2018-04-20 10:33:36 +10:00
.eslintrc	Update deps && eslintrc	2017-10-02 17:02:44 +10:00
.gitignore	Allow REACT_APP_SITE_URL env variable	2018-01-30 11:48:08 +10:00
.nvmrc	Add .nvmrc	2017-11-02 08:35:28 +10:00
LICENSE	Create LICENSE	2018-02-20 15:17:32 +10:00
netlify.toml	Add netlify.toml	2017-11-17 07:42:40 +10:00
package.json	Allow uris with spaced in markdown renderer	2018-04-18 14:39:13 +10:00
postcss.config.js	Add postcss-cssnext build script	2018-01-23 14:31:57 +10:00
README.md	Add badges	2018-02-06 12:17:04 +10:00
sw-precache-config.js	Add /images/ to runtimeCaching	2018-02-02 15:27:50 +10:00
yarn.lock	Upgrade react	2018-04-26 15:29:13 +10:00

README.md

🌶 Netlify CMS + React Starter

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

Create React App
React Router for routing
React Helmet for document titles, descriptions, meta
React Snapshot for pre-rendering to static html so it works without Javascript ⭐️
Netlify CMS for content management

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

Get going

Hit the Deploy to Netlify button. This will:

Clone the repo into your Github account
Create you a new project on Netlify, build & deploy

Once your Netlify project has been created, change a couple of settings:

Enable Identity
Change Registration Preferences to Invite Only
Enable Git Gateway

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.

Developing

Clone your repo to your local machine
Install dependencies

yarn or npm install

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:

Changes will be pushed to the remote repo.
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.

README.md Unescape Escape