https://github.com/tinalabs/tinacms-contentful

Edit your Contentful Site with TinaCMS
https://github.com/tinalabs/tinacms-contentful

cms contentful react tinacms

Last synced: about 1 month ago
JSON representation

Edit your Contentful Site with TinaCMS

• Host: GitHub
• URL: https://github.com/tinalabs/tinacms-contentful
• Owner: tinalabs
• Created: 2020-06-04T19:20:37.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-10-03T09:02:50.000Z (about 1 year ago)
• Last Synced: 2024-09-30T13:06:29.539Z (about 2 months ago)
• Topics: cms, contentful, react, tinacms
• Language: TypeScript
• Homepage:
• Size: 13.7 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 54
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# react-tinacms-contentful

This package provides helpers for setting up TinaCMS to use the Contentful API as well as user authentication with Contentful.

## Pre-requisites

To use this plugin, the following is expected:

- You have a working application with [TinaCMS already setup](https://tinacms.org/docs/cms)

- You have setup [OAuth applications with Contentful](https://www.contentful.com/developers/docs/extensibility/oauth/) if you plan to have your users authenticate with Contentful

- You have a space with Content Models and Entries ready to use

## Quick Start

To get up and running quickly, follow the instructions for your tech stack:

- [`tinacms-contentful`](https://tinalabs.github.io/tinacms-contentful/): plain Javascript APIs for client-side javascript.

- [`react-tinacms-contentful`](https://tinalabs.github.io/tinacms-contentful/react-tinacms-contentful/): React-specific APIs.

- [`next-tinacms-contentful`](https://tinalabs.github.io/tinacms-contentful/next-tinacms-contentful/): Next.js-specific APIs.

## Guides

There are three different approaches to using Contentful with TinaCMS, depending on your application's configuration:

1. [*Client-side with READ-only access tokens*](https://github.com/tinalabs/tinacms-contentful/tree/master/guides/client-side.md), allowing you to fetch entries, assets, and other data from Contentful's API in your client-side JS.

2. [*Client-side editing with OAuth user authentication*](https://github.com/tinalabs/tinacms-contentful/tree/master/guides/client-side-editing.md), which allows users of your Contentful organization to login to their account to edit the content with Tina that they are allowed to access in Contentful, and allow you to perform CRUD operations on their behalf.

3. [*Client-side and serverless editing with Oauth user authentication with Next.js Edit Mode*](https://github.com/tinalabs/tinacms-contentful/tree/master/guides/next-serverless-editing.md), which allows you to maintain server-side sessions for logged in users across multiple tabs in your Next.js application, and manage content in Contentful in API functions, `getStaticProps`, and `getServerSideProps`.

There are also the following use-case specific guides:

1. [*Editing entries with link fields*](./guides/editing-link-fields.md), which allows you to build complex data structures using Contentful Link fields and edit them with a single TinaCMS form.

2. [*Adding new features to the CMS using Contentful*](./guides/plugins.md), such as adding toolbar widgets, screen plugins, custom fields, and custom form actions.

## Roadmap

The following is a series of things _we would like to add_ or are _considering adding_ to the plugins, if time and resources submits:

- The ability to create, update, and delete content models as the user using the `ContentfulClient` and in TinaCMS sidebar and toolbar as forms/content creators/screen plugin(s).

- The ability to manage media from multiple spaces at one time