From 723bca069cdb346729c0157138d36ffd314499e6 Mon Sep 17 00:00:00 2001 From: ericjinks Date: Sat, 18 Nov 2017 04:48:36 +0000 Subject: [PATCH] =?UTF-8?q?Update=20Pages=20=E2=80=9Chome-page=E2=80=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/pages/home.md | 65 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) diff --git a/content/pages/home.md b/content/pages/home.md index 713d5c9..be93818 100644 --- a/content/pages/home.md +++ b/content/pages/home.md @@ -2,4 +2,67 @@ title: Hello World! subtitle: --- -Hello World! +# 🌶 Netlify CMS + React Starter + +[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](http://standardjs.com/) + +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)** +- **[Styled Components](https://github.com/styled-components/styled-components)** for component-based styling +- **[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) + +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, change 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** + +## 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](https://github.com/AustinGreen/gatsby-starter-netlify-cms)