All of this project's code can be found in the First Look monorepo on my GitHub.
KeystoneJS is a CMS for developers that provides a GraphQL API & Management UI for content and data based on your schema. In this tutorial we will use
create-keystone-app to scaffold a basic blog dashboard with users. In a future part we will deploy this project.
create-keystone-app is a CLI app for getting started with Keystone. It will generate a couple of files for you and install all the dependencies you need to run the Admin UI and start using the GraphQL API.
yarn create keystone-app
success Installed "email@example.com" with binaries:
ℹ️ You're about to generate a project using Keystone
Next packages. If you'd like to use Keystone 5, please
use `create-keystone-5-app` instead. Learn more about
the changes between Keystone 5 and Keystone Next on
Give your project a name. Mine will be called
✔ What directory should create-keystone-app generate your app into? · ajcwebdev-keystone
You can follow the first half of this guide to see how to spin up the database. The only important difference is when you copy your connection string from Railway, change the first part from
Your connection string will look like this with a password instead of
✔ What database url should we use? · postgres://postgres:firstname.lastname@example.org:6787/railway
This will create the app and provide further instructions.
🎉 Keystone created a starter project in: ajcwebdev-keystone
To launch your app, run:
- cd ajcwebdev-keystone
- yarn dev
- Edit ajcwebdev-keystone/keystone.ts to customize your app.
- Open the Admin UI - http://localhost:3000
- Read the docs - https://next.keystonejs.com
- Star Keystone on GitHub - https://github.com/keystonejs/keystone
yarn dev to start your local development server.
This will run
$ keystone-next dev
✨ Starting Keystone
⭐️ Dev Server Ready on http://localhost:3000
✨ Generating GraphQL and Prisma schemas
✨ Your database is now in sync with your schema. Done in 3.17s
✨ Connecting to the database
✨ Generating Admin UI code
✨ Creating server
✨ Preparing GraphQL Server
✨ Preparing Admin UI Next.js app
info - Using webpack 4. Reason: custom
webpack configuration in next.config.js
event - compiled successfully
👋 Admin UI and GraphQL API ready
You are then asked if you want to sign up for the KeystoneJS newsletter. Bold move!!!
After you decide whether to reward such brash behavior you will be taken to the Keystone dashboard where you can view your users and posts.
You will see the user you initially created.
You will see that there are no posts yet. What ever shall we do?
After clicking "Create Post" you will be able to create a post.
Write a post. Make it a masterpiece.
Look back at your database to make sure it didn't explode.
Open localhost:3000/api/graphql and run the following
Turns out deploying a Keystone app is kind of complicated unless you follow a separate guide called How to embed Keystone + SQLite in a Next.js app.