JSON Form Editor extension

Forked from Contentful Extensions.

This extension is used for editing meta tags on Contentful. This extension provides a JSON form editor based on the JSON Editor) library. You can use this extension with 'Object' field types.

The extension generates a form based on a JSON Schema defined in json-form-editor.js. The generated form allows you to create JSON objects that are valid against that schema.

Getting started with local development

Check you have the requirements needed to use our extensions and have the extensions SDK installed.

Install the dependencies needed with npm install.

Create the extension on Contentful:

bash contentful-extension create --space-id <space-id>

Serve on http://localhost:3000 using Gulp, automatically watching and reserving any changes:

bash gulp watch

The same constraints apply to loading unsafe scripts.

Hosting

The hosting of a Contentful ui extension can be done in one of two ways:

• uploading files directly to Contentful
• providing Contentful with a url pointing toward an already hosted extension

We have chosen the second option. For this particular project, the extension is hosted using GitHub Pages, which you can observe here.

Deploying

The short answer is run npm run deploy, so long as you have push access - you can deploy.

What happens behind the scenes, is we build into dist/, then we use a node program called gh-pages to deploy the project. Really all this program does is commits everything in dist/ to the gh-pages branch. It should take no longer than a couple of minutes to deploy. If takes any longer, you can get a basic status from the settings tab on the repository.