npm 包 generator-ulayera-keystone 使用教程

阅读时长 4 分钟读完

介绍

generator-ulayera-keystone 是一款基于 Yeoman (一个前端脚手架) 开发的快速生成 KeystoneJS 项目的工具。Keystone 是一个优秀的 Node.js CMS 框架,可以让你快速构建出一个具有完整管理后台的网站,让前端开发者可以专注于网站页面的构建。

本教程将指导您如何使用 generator-ulayera-keystone 快速搭建 KeystoneJS 项目以及对所生成的项目进行简单的配置和使用,并且会提供一些示例代码以供参考。

环境要求

  • Node.js (>=10.13.0)
  • npm (>=5.2.0)

安装

安装 generator-ulayera-keystone 可以使用以下命令:

使用

生成 Keystone 项目

进入到您想要创建 Keystone 项目的目录下,使用以下命令生成项目:

如果安装和使用都没有问题,会出现以下的命令行提示:

-- -------------------- ---- -------
     -------
    -       -    ----------------------------
    ---------    - ------- -- ------- -------- -
   -----------   ----------------------------
    - ----- -       -      -------- -----      -
    ---------       - ------- -------          -
     -  -  -        ----------------------------
   -----------
 -   -  -- - - -

您需要回答几个 Keystone 项目的基本配置问题:

  1. 是否启用邮箱验证(默认为 false)?
  2. 管理员邮箱地址?
  3. 管理员密码?
  4. Keystone 数据库的连接字符串?
  5. 你的项目名?

启动 Keystone 项目

进入生成的 Keystone 项目所在的目录中,例如:

然后运行以下命令启动 Keystone 项目:

启动后,您就可以在浏览器中访问 http://localhost:3000 来访问网站了。

使用 KeystoneJS 的管理后台进行管理

KeystoneJS 生成的项目默认启用了一个基于 React 的管理后台,可以直接在浏览器中访问 http://localhost:3000/keystone 来管理你的网站。

其他

在你的项目根目录下,您会看到一个名为 .env 的文件,这个文件包含了许多您项目配置的重要信息,可以在这里进行修改。

示例代码

访问 KeystoneJS 中的数据

KeystoneJS 可以让你非常简便地读取,写入,更新以及删除 MongoDB 中存储的数据。以下是一个简单的例子:

-- -------------------- ---- -------
----- -------- - --------------------

---------------
  -------- ---------------------------------
  --------- -------------
  ----- -------- ----
---

-------------------

----- ---- - ----------------------

---------------------------- ------ -- -
  -------------------
---

创建 KeystoneJS 中的模板

模板是 KeystoneJS 用于显示页面的基础,下面是一个简单的模板例子:

-- -------------------- ---- -------
--------- -----
----- ----------
------
  ----- ----------------
  ------------------------
-------
------
  ------------------
  ------------------
-------
-------

总结

本篇文档介绍了如何使用 generator-ulayera-keystone 快速搭建 KeystoneJS 项目,以及 KeystoneJS 的一些基本使用和示例代码。希望本文能对您进行 KeystoneJS 开发工作有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600572cd81e8991b448e900f

纠错
反馈