AdonisJS Fold 开源项目教程

AdonisJS Fold 开源项目教程

foldIoC container with all required goodies to write scalable node applications项目地址:https://gitcode.com/gh_mirrors/fold2/fold

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

AdonisJS Fold 项目的目录结构如下：

/adonisjs/fold
├── app
│   ├── Commands
│   ├── Models
│   ├── Middleware
│   ├── Listeners
│   └── Services
├── config
│   ├── app.js
│   ├── database.js
│   └── session.js
├── database
│   ├── migrations
│   └── seeds
├── public
│   └── assets
├── resources
│   ├── views
│   └── lang
├── start
│   ├── routes.js
│   ├── kernel.js
│   └── events.js
├── test
│   ├── unit
│   └── functional
├── .env
├── .env.example
├── .gitignore
├── package.json
└── server.js

目录结构介绍

• app: 包含应用程序的核心代码，如命令、模型、中间件、监听器和服务。
• config: 包含应用程序的配置文件，如 app.js, database.js, session.js 等。
• database: 包含数据库迁移和种子文件。
• public: 包含静态资源文件，如图片、CSS 和 JavaScript 文件。
• resources: 包含视图文件和语言文件。
• start: 包含应用程序的启动文件，如路由、内核和事件。
• test: 包含单元测试和功能测试文件。
• .env: 环境变量文件。
• .env.example: 环境变量示例文件。
• .gitignore: Git 忽略文件。
• package.json: 项目依赖和脚本文件。
• server.js: 应用程序的入口文件。

2. 项目的启动文件介绍

server.js

server.js 是 AdonisJS Fold 项目的入口文件，负责启动应用程序。以下是 server.js 的基本内容：

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

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

start/routes.js

start/routes.js 文件定义了应用程序的路由。以下是 routes.js 的基本内容：

const Route = use('Route')

Route.get('/', ({ view }) => {
  return view.render('welcome')
})

start/kernel.js

start/kernel.js 文件定义了应用程序的内核，包括全局中间件、命名中间件和路由中间件。以下是 kernel.js 的基本内容：

const { ServiceProvider } = require('@adonisjs/fold')

class AppProvider extends ServiceProvider {
  register () {
    // 注册服务
  }

  boot () {
    // 启动服务
  }
}

module.exports = AppProvider

start/events.js

start/events.js 文件定义了应用程序的事件监听器。以下是 events.js 的基本内容：

const Event = use('Event')

Event.on('user::created', 'User.created')

3. 项目的配置文件介绍

config/app.js

config/app.js 文件包含了应用程序的基本配置，如应用名称、应用密钥、时区和 URL。以下是 app.js 的基本内容：

module.exports = {
  name: 'AdonisJS Fold',
  key: Env.get('APP_KEY'),
  timezone: 'UTC',
  url: 'http://localhost:3333',
}

config/database.js

config/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

foldIoC container with all required goodies to write scalable node applications项目地址:https://gitcode.com/gh_mirrors/fold2/fold