diff --git a/README.md b/README.md index 77d9067..3fba8ec 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,11 @@ 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 +* **[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. @@ -19,41 +18,40 @@ I aim to include commonly used components and best-practices e.g. forms, setting 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 +* 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** +* 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** +* 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). - +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 +1. Install dependencies - `yarn` or `npm install` +`yarn` or `npm install` 1. Run the development server - `yarn start` or `npm run start` +`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. 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`. +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 diff --git a/content/pages/home.md b/content/pages/home.md index 5478625..fa2980f 100644 --- a/content/pages/home.md +++ b/content/pages/home.md @@ -2,18 +2,18 @@ title: Hello World! subtitle: --- + # 🌶 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 +* **[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. @@ -22,34 +22,36 @@ I aim to include commonly used components and best-practices e.g. forms, setting [![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 + + * 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** + + * 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** + * Open the **Identity** tab and hit **Invite Users** ## Developing 1. Clone your repo to your local machine -1. Install dependencies +1. Install dependencies - `yarn` or `npm install` + `yarn` or `npm install` 1. Run the development server - `yarn start` or `npm run start` + `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. +* 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`. +* 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