diff --git a/README.md b/README.md index ba015d8..0b334df 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ ## The node.js example app -The node.js Example App aims at getting across the very basics of how to work with our headless content management system and how to build apps using our officially supported JavaScript SDK. You’ll learn best practices for using the SDK to deliver content to your app and additionally learn some techniques for modelling your content in Contentful. +The node.js example app teaches the very basics of how to work with Contentful: -We hope this app will give you a better understanding of how decoupling content from its presentation enables greater flexibility and facilitates shipping higher quality software more quickly. +- consume content from the Contentful Delivery and Preview APIs +- model content +- edit content through the Contentful web app -Contentful is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit and manage content in the cloud and publish it anywhere via powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations. +The app demonstrates how decoupling content from its presentation enables greater flexibility and facilitates shipping higher quality software more quickly. Screenshot of the example app +You can see a hosted version of `The node.js example app` on Heroku. + +## What is Contentful? +Contentful is content infrastructure for web applications, mobile apps and connected devices. It allows you to create, edit and manage content in the cloud and publish it anywhere via powerful APIs. Contentful offers tools for editorial teams and enabling cooperation between organizations. + ## Requirements * Node 8 @@ -16,23 +23,7 @@ Contentful is a content management platform for web applications, mobile apps an Without any changes, this app is connected to a Contentful space with read-only access. To experience the full end-to-end Contentful experience, you need to connect the app to a Contentful space with read _and_ write access. This enables you to see how content editing in the Contentful web app works and how content changes propagate to this app. -You can clone the space for this example app to your own Contentful account by using our CLI tool. - -``` -contentful space seed -s '' -t the-example-app -``` - -If you do not have the Contentful CLI installed you can find instructions on installation and usage [here](https://github.com/contentful/contentful-cli). For more information on the content model check out [this repo](https://github.com/contentful/content-models/tree/master/the-example-app/README.md). - -Once you’ve created a space, you can change the credentials in the variables.env. If you don’t feel like changing code immediately, you can also inject credentials via url parameters like so: - -``` -http://localhost:3000?space_id=&delivery_token=&preview_token= -``` - -If you do not have the Contentful CLI installed you can find instructions on installation and usage [here](https://www.npmjs.com/package/contentful-cli). For more information on the content model check out [this repo](https://github.com/contentful/content-models/tree/master/the-example-app/README.md). - -Once you’ve created a space, you can change the credentials in the variables.env. If you don’t feel like changing code immediately, you can also inject credentials via url parameters like so: +## Common setup Clone the repo and install the dependencies. @@ -52,12 +43,12 @@ To start the express server, run the following npm run start:dev ``` -Open [http://localhost:3000](http://localhost:3000) and take a look around. +Open [http://localhost:3000](http://localhost:3000) and take a look around. ## Steps for read and write access (recommended) -Step 1: Install the [Contentful CLI](https://www.npmjs.com/package/contentful-cli) +Step 1: Install the [Contentful CLI](https://www.npmjs.com/package/contentful-cli)) Step 2: Login to Contentful through the CLI. It will help you to create a [free account](https://www.contentful.com/sign-up/) if you don't have one already. ``` @@ -71,15 +62,15 @@ Step 4: Seed the new space with the content model. Replace the `SPACE_ID` with t ``` contentful space seed -s '' -t the-example-app ``` -Step 5: Head to the Contentful web app's API section and grab `SPACE_ID`, `DELIVERY_ACCESS_TOKEN`, `PREVIEW_ACCESS_TOKEN`. +Step 5: Head to the Contentful web app's API section and grab `SPACE_ID`, `DELIVERY_ACCESS_TOKEN`, `PREVIEW_ACCESS_TOKEN`. Step 6: Open `variables.env` and inject your credentials so it looks like this ``` NODE_ENV=development -CONTENTFUL_SPACE_ID= -CONTENTFUL_DELIVERY_TOKEN= -CONTENTFUL_PREVIEW_TOKEN= +CONTENTFUL_SPACE_ID={{SPACE_ID}} +CONTENTFUL_DELIVERY_TOKEN={{DELIVERY_ACCESS_TOKEN}} +CONTENTFUL_PREVIEW_TOKEN={{PREVIEW_ACCESS_TOKEN}} PORT=3000 ``` @@ -91,6 +82,12 @@ Final Step: Open [http://localhost:3000?enable_editorial_features](http://localhost:3000?enable_editorial_features) and take a look around. This URL flag adds an “Edit” button in the app on every editable piece of content which will take you back to Contentful web app where you can make changes. It also adds “Draft” and “Pending Changes” status indicators to all content if relevant. +## Deploy to Heroku +You can also deploy this app to Heroku. +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) + +Open [http://localhost:3000?enable_editorial_features](http://localhost:3000?enable_editorial_features) and take a look around. This URL flag adds an “Edit” button in the app on every editable piece of content which will take you back to Contentful web app where you can make changes. It also adds “Draft” and “Pending Changes” status indicators to all content if relevant. + ## Deploy to Heroku You can also deploy this app to Heroku: