Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.16 KB

README.md

File metadata and controls

53 lines (36 loc) · 2.16 KB
Raw

SEO Metadata Field

This is an SEO Metadata field widget, built on top of the JSON field type. It collects some basic data that we use for metadata when building pages.

To use

  1. In contentful, create a new app with the name SEO Field Widget
  2. Allow the app to use the Field location, for the JSON field type
  3. Upload the contents of the ./dist directory from your codebase
  4. Install the app to your space and environment
  5. On a page content type, create JSON field called SEO.
  6. Scroll down to the widget selection and choose SEO Fields.
  7. Save the field and content type.

Available Scripts

In the project directory, you can run:

npm start

Creates or updates your app definition in Contentful, and runs the app in development mode. Open your app to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

npm run upload

Uploads the build folder to contentful and creates a bundle that is automatically activated. The command guides you through the deployment process and asks for all required arguments. Read here for more information about the deployment process.

npm run upload-ci

Similar to npm run upload it will upload your app to contentful and activate it. The only difference is
that with this command all required arguments are read from the environment variables, for example when you add the upload command to your CI pipeline.

For this command to work, the following environment variables must be set:

  • CONTENTFUL_ORG_ID - The ID of your organization
  • CONTENTFUL_APP_DEF_ID - The ID of the app to which to add the bundle
  • CONTENTFUL_ACCESS_TOKEN - A personal access token