Keystone Examples

Welcome to the Keystone Example Projects 👋. Here you'll find a collection of projects which show off the various features in Keystone.

You can use these examples as a jumping off point for adding features to your own Keystone project.

Base Projects

There are two base projects which all the other examples build off. The todo project is a basic task management application, while the blog project is a basic blogging app.

These projects have very simple schemas and none of the bells or whistles you'd expect in a complete project. You can use these as a starting point for general experimentation in a clean environment.

Feature Examples

Each of the examples below demonstrates a particular feature of Keystone. You can use these projects to learn about, and experiment with specific features.

• withAuth: Adding password based authentication to your Keystone application.
• Data Seeding: Coming soon
• GitHub SSO: Coming soon
• Roles: Coming soon
• Logging: Coming soon
• Custom Fields: Coming soon
• Custom Views: Coming soon
• REST APIs: Coming soon
• Validation: Coming soon
• Images: Coming soon
• Files: Coming soon
• Hooks: Coming soon
• Access Control: Coming soon
• Document Field: Coming soon
• Relationships: Coming soon
• Schema Extension: Coming soon
• Virtual Fields: Coming soon
• Default Values: Coming soon
• Select Fields: Coming soon
• Tracking Meta: Coming soon
• Next.js App: Coming soon
• Null Handling: Coming soon
• ID Fields: Coming soon
• Fields: Coming soon

Solution Examples

The solution examples show you how to bring together all of the features of Keystone to build a complete product solution. These examples show how the different features of Keystone work together in a more complex project.

(coming soon)

Running examples

To run an example you should clone this repo and then run the following commands:

yarn
cd examples/<feature>
yarn dev

If everything works 🤞 the GraphQL Server and Admin UI will start on localhost:3000. See the README in each example for more specific details.

Getting in touch

If you have trouble running these examples, or find a bug, please open an issue and tag it with the examples tag on GitHub.

Otherwise if you want to ask questions or have a chat with us, join us in Slack!

Follow @KeystoneJS on Twitter for updates.