https://github.com/netlify/demo-restaurant-data-contentful
https://github.com/netlify/demo-restaurant-data-contentful
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/netlify/demo-restaurant-data-contentful
- Owner: netlify
- Created: 2021-09-08T09:06:48.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-10T10:01:22.000Z (over 2 years ago)
- Last Synced: 2025-02-25T13:15:43.669Z (4 months ago)
- Language: JavaScript
- Size: 22.5 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
# demo-restaurant-data-contentful
A Netlify build plugin to fetch content from a Contentful space and save it as JSON files in the ready for an SSG to use to generate an example restaurant site.
Data will be delivered as per the schema defined here: https://github.com/netlify/dx-restuarant-sites-data
## Usage for Development and Deployment
This plugin is to be used as a local plugin and not added to the official Netlify Plugin register.
### Include in your project as git submodule
Running this command will include the code from this plugin's repo into your project at the required location
```bash
git submodule add https://github.com/netlify/demo-restaurant-data-contentful netlify/plugins/demo-restaurant-data-contentful
```
As the plugin improves, you can pull those changes in to your code by periodically running this command:
```bash
git pull --recurse-submodules
```
### Add the plugin to your project's `netlify.toml`
```toml
[[plugins]]
package = "./netlify/plugins/demo-restaurant-data-contentful"
[plugins.inputs]
# Directory for the generated JSON data files to reside in
dataDir = "data"
```
If you've configured your SSG to use a specific folder to use for data, replace the value of the `dataDir` option with the name of the folder you're using. If it does not yet exist, this directory will be created automatically so the JSON file can be copied inside it.
### add the Contentful creds to your project as environment variable
You can use the Netlify CLI for this
```
# Create or link your project with Netlify
netlify create
# or
netlify link
# Add the Contentful Space ID
netlify env:set CONTENTFUL_SPACE_ID XXX
# Add the Contentful Content Delivery API access token
netlify env:set CONTENTFUL_CONTENT_API_TOKEN XXX
# Run Netlify Build to prime your build cache with the data
# This will use your centrally managed env vars
netlify build
# You now have data to build against
netlify dev
```