Skip to content
KeystoneJS LogoKeystoneJS (α)

Quick Start

Welcome

This quick start guide will get you up and running with a fresh new KeystoneJS application in just a few easy commands.

With just 5 minutes, this is what you're going to build:

Screenshot of the final Todo app

Screenshot of KeystoneJS Admin Dashboard

Screenshot of KeystoneJS Admin Todo List

Requirements

Please make sure your computer/server meets the following requirements:

  • Node.js >= 10.x: Node.js is a server platform which runs JavaScript.
  • MongoDB >= 4.x: MongoDB is a powerful document store.

Installation

To create a new KeystoneJS application, ensure mongodb is running and then run the following commands.

npm init keystone-app my-app
cd my-app
npm start

or with yarn:

yarn create keystone-app my-app
cd my-app
yarn start

Congratulations, you are now running your very own KeystoneJS application! To visit your running application (a simple todo list), visit

http://localhost:3000

Your application also has an Admin UI, which lets you directly manipulate the data in your database

http://localhost:3000/admin

Both your application and the admin UI are powered by a GraphQL API. KeystoneJS provides a web interface for this API at

http://localhost:3000/admin/graphiql

Up Next

Have you found a mistake, something that is missing, or could be improved on this page? Please edit the Markdown file on GitHub and submit a PR with your changes.

Edit Page