开始

官方提供了一个 AdonisJS 扩展开发模板。当然你可以根据自己的文件夹结构和工作流程从头开始创建。但是使用此入门模板可以加快创建过程。

安装扩展模板

在命令行运行此命令，并将 project_name 替换为你自己的项目名

注意：后续案例说明都将以 project_name 为例，project_name 为你的目录名和包名，实际操作中请自动修改。

npx giget@latest gh:adonisjs/pkg-starter-kit project_name

• 安装依赖项。
• 更新package.json文件并定义name、description、keywords和author属性。
• 本代码库为 MIT 许可证。如无需MIT许可，请自行更改。

文件夹结构

以下为模板的文件夹结构。你可以根据需要随意重命名文件和文件夹。

├── .github // Github 应用程序（按需可删除）
├── providers   // 框架启动时执行（按需添加）
├── src    // 你的代码包
├── bin   // 命令行（无需修改）
├── stubs  // 代码模板
├── configure.ts   // 执行(node ace configure)命令时自动运行
├── index.ts  // 入口文件
├── LICENSE.md
├── package.json
├── README.md
├── tsconfig.json
├── tsnode.esm.js

文件系统命名约定

我们对文件系统使用snake_case命名约定。该规则由 ESLint 强制执行。不过，您可以关闭该规则并使用您偏好的命名约定。