Skip to content

A Contentful App to generate typescript types based on contentful's content types.

License

Notifications You must be signed in to change notification settings

marcolink/cf-content-types-generator-app

Repository files navigation

Netlify Status TypeScript

TS Content Types Generator App

A Contentful App to generate typescript types based on contentful's content types. It utilizes the cf-content-types-generator CLI.

Screenshot of Typescript types generator inside of the Contentful UI

This project was bootstrapped with Create Contentful App, and deployed to https://cf-content-types-generator-app.netlify.app

1 click installation

Install to Contentful

Setup

The Contentful App Framework allows developers to extend the Contentful UI with custom functionality. You can install the app and use its hosted version without editing any code.

To install and develop this app head over to your organization settings and create a new app. Screenshot of Typescript types generator app setup in the Contentful UI

Define the application name you prefer and the following App URL: https://cf-content-types-generator-app.netlify.app.

This app supports the following locations in the Contentful UI:

  • (Required) Page (page) - use TS Content Types Generator app as a full page app

Screenshot of Typescript types generator app setup in the Contentful UI

Thank you Stefan Judis for letting me steal your Setup description

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!

Libraries to use

To make your app look and feel like Contentful use the following libraries:

Learn More

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

Create Contentful App uses Create React App. You can learn more in the Create React App documentation and how to further customize your app.