Lighthouse API 项目教程

Lighthouse API 项目教程

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

lighthouse-api/
├── README.md
├── app/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   └── views/
├── config/
│   ├── database.js
│   └── environment.js
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── test/
│   ├── integration/
│   └── unit/
├── package.json
└── server.js

• README.md: 项目说明文件。
• app/: 包含应用程序的主要代码，分为控制器、模型、路由和视图。
• config/: 包含项目的配置文件，如数据库配置和环境配置。
• public/: 存放静态文件，如CSS、JavaScript和图片。
• test/: 包含集成测试和单元测试。
• package.json: 项目的依赖和脚本配置。
• server.js: 项目的启动文件。

2. 项目的启动文件介绍

server.js 是项目的启动文件，负责启动服务器并加载必要的配置。以下是 server.js 的基本结构：

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

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

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

• 引入 Express 框架：使用 express 模块创建一个应用实例。
• 加载配置：从 config/environment.js 文件中加载环境配置。
• 加载路由：通过 app/routes 模块加载应用程序的路由。
• 启动服务器：监听配置文件中指定的端口，启动服务器。

3. 项目的配置文件介绍

config/environment.js 是项目的配置文件，负责管理不同环境下的配置。以下是 environment.js 的基本结构：

module.exports = {
  development: {
    port: 3000,
    database: {
      host: 'localhost',
      user: 'root',
      password: '',
      database: 'lighthouse_dev'
    }
  },
  production: {
    port: process.env.PORT || 80,
    database: {
      host: 'production_host',
      user: 'prod_user',
      password: 'prod_password',
      database: 'lighthouse_prod'
    }
  }
};

• 开发环境配置：定义开发环境下的端口和数据库连接信息。
• 生产环境配置：定义生产环境下的端口和数据库连接信息，端口优先使用环境变量中的设置。

通过以上配置文件，可以根据不同的运行环境加载相应的配置，确保应用程序在不同环境下都能正常运行。