Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 3.32 KB

README.md

File metadata and controls

72 lines (44 loc) · 3.32 KB
Raw

Contentful Blurhash App

A Contentful field editor app to generate a blurhash representation of an image.

blurhash-entry.png

1 click installation

Install to Contentful

Setup

During the installation process, the app will automatically create a new content type called Blurhash Image with a field called Image which will act as the blurhash source, and a field called Blurhash which will store the generated blurhash value.

blurhash-setup.png You need to manually configure the blurhash field appearance by assigning any ShortText field to the Blurhash app.

Configuration

The app works out of the box without any further configuration. However, you can adjust the blurhash parameters to your needs. The app supports the following parameters:

  • Source Image Field ID: The ID of the field that contains the image to generate the blurhash from. The default value is image.
  • Component X: The number of components in the X direction. The default value is 4.
  • Component Y: The number of components in the Y direction. The default value is 3.

How to pick the right amount of components?

Demo

https://marcolink.github.io/contentful-blurhash-app/

Development

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 dist 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 dist 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

Learn More

Read more and check out the video on how to use the CLI.