Skip to Page NavigationSkip to Page NavigationSkip to Content
Keystone 6 is in Community Preview! What does that mean? see our Roadmap. For Keystone 5 docs, visit v5.keystonejs.com

Examples

Keystone has a wide range of highly configurable features. Our examples are a growing collection of projects you can run locally to learn more about a particular feature of Keystone.

Every project comes with its own docs that explain the how and why. They're useful as a reference for best practice, and as a jumping off point when adding features to your own Keystone project.

See the full set of examples in ourGitHub Repo

Blog

A basic Blog schema with Posts and Authors. Use this as a starting place for learning how to use Keystone. It’s also a starter for other feature projects.

Task Manager

A basic Task Management app, with Tasks and People who can be assigned to tasks. Great for learning how to use Keystone. It’s also a starter for other feature projects.

Extend GraphQL Schema

Shows you how to extend the Keystone GraphQL API with custom queries and mutations. Builds upon the Blog starter project.

Default Values

Demonstrates how to use default values for fields. Builds upon the Task Manager starter project.

Virtual fields

Implements virtual fields in a Keystone list. Builds on the Blog starter project.

Document field

Illustrates how to configure document fields in your Keystone system and render their data in a frontend application. Builds on the Blog starter project.

Testing

Shows you how to write tests against the GraphQL API to your Keystone system. Builds on the Authentication example project.

Authentication

Adds password-based authentication to the Task Manager starter project.

JSON Field

Illustrates how to use the json field type. Builds on the Task Manager starter project.

Custom Field View

Adds a custom Admin UI view to a json field which provides a customised editing experience for users. Builds on the Task Manager starter project.

Custom Field Type

Adds a custom field type based on the integer field type which lets users rate items on a 5-star scale. Builds on the Blog starter project.

Custom Admin UI Pages

Adds a custom page in the Admin UI. Builds on the Task Manager starter project.

Custom Admin UI Logo

Adds a custom logo component in the Admin UI. Builds on the Task Manager starter project.

Custom Admin UI Navigation

Adds a custom Navigation component to the Admin UI. Builds on the Task Manager starter project.