安装
AdonisJS 作为一个 Node.js 框架,对 Node.js
有核心依赖,请确保你已安装 Node.js,且 Node.js
版本大于等于 V14
。
你可以通过运行以下命令来检查 Node.js
和 npm
版本。
# 检查 node.js 版本
node -v
如果你没有安装 Node.js
, 你可以在 官方网站 下载安装适合你操作系统的 Node.js
版本。
如果你习惯使用命令行,那么我们建议你使用 Volta 或 Node Version Manager 在你的计算机上安装和运行多个版本的 Node.js
。
创建新项目#
你可以选择使用 npm init,yarn create 或 pnpm create 创建新项目,这些工具将下载 AdonisJS 脚手架并开始安装过程。
# 使用 npm 安装
npm init adonis-ts-app@latest hello-world
# 使用 yarn 安装
yarn create adonis-ts-app hello-world
# 使用 pnpm 安装
pnpm create adonis-ts-app hello-world
安装过程会提示你进行以下选择。
项目结构 (Project structure)#
你可以在以下项目结构之一中进行选择。
web
非常适合创建典型的服务器呈现的应用程序,配置了对session
的支持,同时还安装了 AdonisJS 模板引擎。api
创建 API 服务器的理想选择。slim
创建尽可能小的 AdonisJS 应用程序,并且不安装除框架核心之外的任何其他包。
项目名称 (Project name)#
项目的名称,安装程序会在 package.json
文件中定义该提示符的值。
配置 eslint 和 prettier (Configure eslint/prettier)#
可选的,你可以配置 eslint 和 prettier,这两个包都配置了 AdonisJS 核心团队使用的设置。
配置 Webpack Encore (Configure Webpack Encore)#
可选的,你也可以配置 Webpack Encore 以捆绑和提供前端依赖项。
请注意,AdonisJS 是一个后端框架,并不关心前端构建工具。因此,webpack 设置是可选的。
启动开发服务器#
创建应用程序后,可以通过运行以下命令启动开发服务器。
node ace serve --watch
serve
命令将启动 HTTP 服务器,并执行 TypeScript 到 JavaScript 的内存编译。--watch
标志用于监视文件系统的更改并自动重启服务器。
默认情况下,服务器在端口 3333 上启动 (在 .env
文件中定义),你可以通过访问以下地址查看欢迎页面: localhost:3333.
生产环境编译#
你必须始终在生产服务器上部署编译后的 JavaScript,运行以下命令可以创建生产版本:
node ace build --production
编译后的输出将写入 build
文件夹。你可以进入该文件夹,直接运行 server.js
文件启动服务器,了解有关 TypeScrip Build process 的更多信息
cd build
node server.js
本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。