Orchid 项目使用教程

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

Orchid 项目的目录结构如下：

orchid/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── routes.js
├── config/
│   ├── database.js
│   └── environment.js
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── test/
│   ├── unit/
│   └── integration/
├── .env
├── .gitignore
├── package.json
└── server.js

目录介绍

• app/: 包含应用程序的主要代码。
  • controllers/: 存放控制器文件。
  • models/: 存放模型文件。
  • views/: 存放视图文件。
  • routes.js: 定义应用程序的路由。
• config/: 包含配置文件。
  • database.js: 数据库配置文件。
  • environment.js: 环境配置文件。
• public/: 存放静态文件，如 CSS、JavaScript 和图片。
• test/: 包含测试文件。
  • unit/: 单元测试文件。
  • integration/: 集成测试文件。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目依赖和脚本配置。
• server.js: 应用程序的启动文件。

2. 项目的启动文件介绍

server.js 是 Orchid 项目的启动文件。它负责启动服务器并加载应用程序的各个模块。以下是 server.js 的主要内容：

const express = require('express');
const app = express();
const config = require('./config/environment');

// 加载配置
app.set('port', config.port);

// 加载路由
require('./app/routes')(app);

// 启动服务器
app.listen(app.get('port'), () => {
  console.log(`Server is running on http://localhost:${app.get('port')}`);
});

启动文件介绍

• 引入 express 模块并创建一个 Express 应用实例。
• 加载 config/environment.js 配置文件，设置端口号。
• 加载 app/routes.js 文件，定义应用程序的路由。
• 启动服务器并监听指定端口。

3. 项目的配置文件介绍

Orchid 项目的配置文件主要存放在 config/ 目录下。

config/database.js

database.js 文件用于配置数据库连接信息。以下是示例内容：

module.exports = {
  development: {
    username: 'root',
    password: 'password',
    database: 'orchid_dev',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  test: {
    username: 'root',
    password: 'password',
    database: 'orchid_test',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  production: {
    username: 'root',
    password: 'password',
    database: 'orchid_prod',
    host: '127.0.0.1',
    dialect: 'mysql'
  }
};

config/environment.js

environment.js 文件用于配置应用程序的环境变量。以下是示例内容：

const dotenv = require('dotenv');
dotenv.config();

module.exports = {
  port: process.env.PORT || 3000,
  env: process.env.NODE_ENV || 'development'
};

配置文件介绍

• database.js: 配置不同环境下的数据库连接信息。
• environment.js: 配置应用程序的端口号和运行环境。

通过以上配置文件，可以灵活地管理应用程序的不同环境设置。