docs(README): rudimentary infos for setup and deep links
This commit is contained in:
committed by
Benedikt Rötsch
parent
2bbe27cb3f
commit
bfd12a28e8
33
README.md
33
README.md
@@ -1,2 +1,35 @@
|
|||||||
# the-example-app.js
|
# the-example-app.js
|
||||||
The Contentful example app, written in JS
|
The Contentful example app, written in JS
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
* Node 8
|
||||||
|
* Git
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone --recursive https://github.com/contentful/example-contentful-university-js.git
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
Open http://localhost:3000/?enable_editorial_features in your browser.
|
||||||
|
|
||||||
|
## Deep links
|
||||||
|
|
||||||
|
The following deep links are supported:
|
||||||
|
|
||||||
|
* `?enable_editorial_features` - Shows `Edit in web app` button on every content type plus `Draft` and `Pending Changes` status pills
|
||||||
|
* `?space_id=xxx&delivery_access_token=xxx&preview_access_token=xxx` - Configure the connected space
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user