Adonis CLI 项目教程

Adonis CLI 项目教程

adonis-cliLegacy Adonis CLI module to generate new application项目地址:https://gitcode.com/gh_mirrors/ad/adonis-cli

1. 项目的目录结构及介绍

Adonis CLI 项目的目录结构如下：

adonis-cli/
├── app/
│   ├── Commands/
│   ├── Providers/
│   └── ...
├── config/
│   ├── app.js
│   ├── database.js
│   └── ...
├── public/
│   └── ...
├── resources/
│   ├── views/
│   └── ...
├── start/
│   ├── routes.js
│   ├── kernel.js
│   └── ...
├── test/
│   └── ...
├── .editorconfig
├── .env
├── .env.example
├── .gitignore
├── .npmignore
├── .snyk
├── .travis.yml
├── ace
├── package.json
└── README.md

目录介绍

• app/: 包含应用程序的核心代码，如命令、服务提供者等。
• config/: 包含应用程序的配置文件，如 app.js 和 database.js。
• public/: 包含静态文件，如图片、CSS 和 JavaScript 文件。
• resources/: 包含视图文件和其他资源文件。
• start/: 包含应用程序的启动文件，如路由和内核配置。
• test/: 包含测试文件。
• .editorconfig: 编辑器配置文件。
• .env: 环境变量配置文件。
• .env.example: 环境变量配置文件示例。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .snyk: Snyk 安全扫描配置文件。
• .travis.yml: Travis CI 配置文件。
• ace: Adonis CLI 命令行工具。
• package.json: npm 包配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

在 start/ 目录下，有几个关键的启动文件：

• routes.js: 定义应用程序的路由。
• kernel.js: 配置应用程序的内核和服务提供者。

routes.js

routes.js 文件用于定义应用程序的路由。示例如下：

const Route = use('Route')

Route.get('/', () => 'Hello World')
Route.get('/users', 'UserController.index')

kernel.js

kernel.js 文件用于配置应用程序的内核和服务提供者。示例如下：

const { Ignitor } = require('@adonisjs/ignitor')

new Ignitor(require('@adonisjs/fold'))
  .appRoot(__dirname)
  .fireHttpServer()
  .catch(console.error)

3. 项目的配置文件介绍

在 config/ 目录下，有几个关键的配置文件：

• app.js: 应用程序的基本配置。
• database.js: 数据库配置。

app.js

app.js 文件包含应用程序的基本配置，如应用程序名称、密钥等。示例如下：

module.exports = {
  name: 'AdonisJs Application',
  key: Env.get('APP_KEY'),
  // 其他配置项...
}

database.js

database.js 文件包含数据库配置，如数据库类型、连接字符串等。示例如下：

module.exports = {
  connection: Env.get('DB_CONNECTION', 'sqlite'),
  sqlite: {
    client: 'sqlite3',
    connection: {
      filename: Helpers.databasePath(`${Env.get('DB_DATABASE', 'development')}.sqlite`),
    },
    useNullAsDefault: true,
  },
  // 其他数据库配置...
}

以上是 Adonis CLI 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

adonis-cliLegacy Adonis CLI module to generate new application项目地址:https://gitcode.com/gh_mirrors/ad/adonis-cli