https://github.com/contentful/create-contentful-app

Bootstrap a Contentful App
https://github.com/contentful/create-contentful-app

app-framework build-tools contentful contentful-app monorepo react zero-configuration

Last synced: 6 days ago
JSON representation

Bootstrap a Contentful App

• Host: GitHub
• URL: https://github.com/contentful/create-contentful-app
• Owner: contentful
• License: mit
• Created: 2020-07-10T08:39:26.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-10T10:51:19.000Z (14 days ago)
• Last Synced: 2025-01-11T14:05:26.273Z (13 days ago)
• Topics: app-framework, build-tools, contentful, contentful-app, monorepo, react, zero-configuration
• Language: TypeScript
• Homepage: https://contentful.com/developers/docs/extensibility/app-framework/create-contentful-app/
• Size: 20.8 MB
• Stars: 107
• Watchers: 54
• Forks: 24
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Create Contentful App

This repository includes multiple npm packages to improve the development experience when writing [Contentful Apps](https://www.contentful.com/developers/docs/extensibility/app-framework/).

### Packages

### `create-contentful-app`

A CLI to easily bootstrap Contentful apps

[More information](packages/contentful--create-contentful-app/README.md)

### `@contentful/app-scripts`

A CLI to perform recurrent operations for Contentful's App Framework.

[More information](packages/contentful--app-scripts/README.md)

### `@contentful/react-apps-toolkit`

Toolkit for building a Contentful app in React.

[More information](packages/contentful--react-apps-toolkit/README.md)

## Development

### Publishing

A new package version is automatically published to npm upon merging on the mainline branch.

To manually publish the package, run `npm run publish`.

#### Canary releases

This package has two main development streams: `latest` and `canary`. Canary releases are labeled as `${CANDIDATE_VERSION}-alpha.${BUILD_NUMBER}` in npm.

Changes on the `canary` branch are automatically published. However, you can still manually make a canary release using `npm run publish:canary`.

#### Stability

The default and stable releases are always published under the `latest` tag (as per npm convention).

The release under the `canary` tag is to be considered unstable and potentially breaking.

You should not rely on it in production.