入门

qimoe 发布于 4 个月前

欢迎使用KeystoneJS!这份快速入门指南将在几分钟之内让您启动并运行KeystoneJS。让我们用全新安装的Keystone构建一个简单的Todo应用程序!

要求

在开始之前,请确保您已经建立了基本的开发环境,并在系统上安装了以下工具。

  • Node.js >= 10.x:Node.js是运行JavaScript的服务器平台。

  • yarnnpm:yarn和npm是不同的程序包管理器,可用于安装Keystone。

$ node --version
v12.11.0
$ npm --version
6.9.0
$ yarn --version
1.17.3

数据库设置

您还需要一个用于Keystone的数据库来存储您的应用程序数据。您可以使用MongoDBPostgreSQL

  • MongoDB >= 4.x:MongoDB是功能强大的NoSQL文档存储数据库。

  • PostgreSQL >= 9.x:PostgreSQL是使用SQL语言的开源关系数据库。

按照数据库设置说明安装和配置数据库,并找出您要使用的数据库连接字段connection string

重要提示:您需要确保您数据库的connection string有效,才能设置Keystone。

安装KeystoneJS

要创建新的Keystone应用程序,请在终端中运行以下命令:

npm init keystone-app my-app
# or
yarn create keystone-app my-app

系统会提示您一些问题:

  1. 您的项目名称是什么?为您的项目选择任何名称。如果愿意,可以稍后更改。

  2. 选择一个入门项目。这些是一些预配置的项目,您可以将它们用作自己的应用程序的基础。Todo如果您希望遵循Keystone教程的其余部分,请选择应用程序。

  3. 选择一种数据库类型。MongoDBPostgreSQL之间选择。

  4. 您的数据库位于哪里?为您的数据库提供链接connection string

  5. 测试您的数据库连接。测试Keystone是否可以连接到数据库。

回答完这些问题后,Keystone将安装在项目目录中。这将需要几分钟的时间,因为需要下载和安装许多依赖项。

设置完项目后,您应该进入其目录,以便可以开始使用它

cd my-app

如果您正在使用PostgreSQL,则需要在数据库中创建表以供Keystone使用。

yarn create-tables
# or
npm run create-tables

现在,您可以使用以下命令启动开发服务器:

yarn dev
# or
npm run dev

故障排除

如果在此阶段遇到数据库相关错误,请按照数据库设置和适配器说明进行操作。

概要

您现在正在运行自己的Keystone应用程序!这是您开箱即用的内容:

应用

您的简单待办应用程序已启动并正在运行:

管理员界面

您的应用程序还具有一个Admin UI,可让您直接操作数据库中的数据:

GraphQL API

您的应用程序和Admin UI均由GraphQL API提供支持。Keystone在以下URL上为此API提供了一个Web界面:

下一步

这个待办事项应用程序很好地介绍了Keystone,但您可能会想构建比这更复杂和安全的东西!

该指南部分是一个伟大的下一步。它将引导您完成诸如创建列表,设置内容关联 ,管理访问控制等概念。