What is this?

This is a TinaCMS-enabled Next.js app, so you can edit your content on a live page. In this project the Tina file-based CMS is used via GraphQL: it's powered by a schema that you define. It not only serves content from Markdown files in your repository, but it also generates TinaCMS forms for you automatically ✨.

New to TinaCMS?

TinaCMS is feature-rich, and leaves a lot of power up to the user on how it's configured.

There can be a learning curve as you get to grips with how it all fits together.

The tutorials in our docs will guide you through the basics, to the more advanced ways to use the tool.

Check out the Learning Guide it covers all you need to get up and running with TinaCMS.

Requirements

• Git
• Node.js Active LTS
• NPM, Yarn, pnpm, or bun

Install

Install the project's dependencies:

npm install

Run the project locally

To run the local development server:

npm run dev

This command starts the GraphQL server and the Next.js application in development mode. It also regenerates your schema types for TypeScript and GraphQL so changes to your /tina/config.ts are reflected immediately.

One of the most interesting aspects of the TinaCloud Content API is that it doesn't actually require anything from the cloud to work locally. Since TinaCMS is by default a Git-backed CMS, everything can be run from your local filesystem via the CLI. 😎

This is ideal for development workflows and the API is identical to the one used in TinaCloud, so once you're ready to deploy your application you won't face any challenges there.

Open http://localhost:3000 in your browser to see your file-based content being loaded from the GraphQL API.

Want to learn more? Go through the Learning Guide to understand how to customise your TinaCMS experience.

Connect to Tina Cloud

While the fully-local development workflow is the recommended way for developers to work, you'll obviously want other editors and collaborators to be able to make changes on a hosted website with authentication.

Check out the docs on how to connect to our hosted backend - Going to Production with TinaCloud

Deploy

Sites using TinaCMS and TinaCloud can be deployed to lots of hosting providers.

We have documented some of the popular ones:

• Vercel
• Netlify
• GitHub Pages
• Alibaba Cloud

If your favourite isn't listed here, it doesn't mean that it isn't supported - we just don't have documentation for it yet.

Getting Help

You might face issues, want to provide feedback or get help with any challenges you may have:

• Read the TinaCloud documentation.
• Join our Discord.
• Visit the community forum to ask questions.
• Reach out to us on Twitter at @TinaCMS.
• Email us to schedule a call with our team and share more about your context and what you're trying to achieve.

LICENSE

Licensed under the Apache 2.0 license.