Introduction

Keystatic is designed to work when you're creating a new site, or to introduce content management into your existing codebase.

It can save data locally, directly to Github, or both.

Below are some of the common use-cases to get you started.


Quick start

New project
Local

Perfect for trying out Keystatic and seeing what it can do.

Good for:

  • Checking out Keystatic for the first time.
  • Doing a demo.
  • Starting a new project.

What you get:

  • A local version of Keystatic running in Next.js or Astro
  • Changes saved to your local file system

Follow the Quick start guide


Github integrated and deployed

New project
github

See the power of Keystatic when integrated with Github, and deployed in Vercel.

Good for:

  • Seeing the power of Keystatic and how it integrates with Github for saving your content.
  • Demonstrating how Keystatic's branch workflow works in the Admin UI.
  • Starting a new project.

What you get:

  • A new project setup on Github.
  • A free, deployed Keystatic Admin UI in Vercel to start editing content.

Follow the GitHub with Vercel guide


Add to your existing project

Existing project
Local
Astro
Next.js

Good for:

  • Make your existing project editable!
  • Add Keystatic to your project with minimal effort.

What you get:

  • Setup Keystatic to work in your existing project.

More framework guides coming soon!