Skip to content

Latest commit

 

History

History
 
 

quick-start

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
section title
quick-start
Introduction

Quick Start

Welcome

This quick start guide will get you up and running with a fresh new Keystone 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.

npx create-keystone-app my-app
cd my-app
npm start

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

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

The Admin UI Tutorial will walk you through the functionality provided by the Admin UI.

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

The Introduction To GraphQL tutorial will guide you through the basics of using GraphQL to interact with your Keystone system.