OJ 开源项目教程

OJ 开源项目教程

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

oj/
├── README.md
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── routes.js
├── config/
│   ├── database.js
│   └── environment.js
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── server.js
└── package.json

目录结构介绍

• README.md: 项目的基本介绍和使用说明。
• app/: 包含应用程序的主要代码。
  • controllers/: 存放控制器文件，处理业务逻辑。
  • models/: 存放数据模型文件，定义数据结构和操作。
  • views/: 存放视图文件，负责前端展示。
  • routes.js: 定义应用程序的路由。
• config/: 存放配置文件。
  • database.js: 数据库配置文件。
  • environment.js: 环境变量配置文件。
• public/: 存放静态资源文件。
  • css/: 存放样式文件。
  • js/: 存放JavaScript文件。
  • images/: 存放图片文件。
• server.js: 项目的启动文件。
• package.json: 项目的依赖管理文件。

2. 项目的启动文件介绍

server.js

server.js 是项目的启动文件，负责启动应用程序。以下是 server.js 的基本结构：

const express = require('express');
const app = express();
const port = process.env.PORT || 3000;

// 引入路由
const routes = require('./app/routes');

// 设置静态文件目录
app.use(express.static('public'));

// 使用路由
app.use('/', routes);

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

启动步骤

1. 确保已经安装了所有依赖，可以通过 npm install 命令安装。
2. 运行 node server.js 启动服务器。
3. 打开浏览器，访问 http://localhost:3000 即可查看应用程序。

3. 项目的配置文件介绍

config/database.js

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

module.exports = {
  development: {
    username: 'root',
    password: 'password',
    database: 'oj_development',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  test: {
    username: 'root',
    password: 'password',
    database: 'oj_test',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  production: {
    username: process.env.DB_USERNAME,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
    host: process.env.DB_HOST,
    dialect: 'mysql'
  }
};

config/environment.js

environment.js 文件用于配置环境变量。以下是一个示例：

module.exports = {
  development: {
    apiUrl: 'http://localhost:3000/api'
  },
  test: {
    apiUrl: 'http://localhost:3000/api'
  },
  production: {
    apiUrl: 'https://api.example.com'
  }
};

配置文件的使用

在应用程序中，可以通过以下方式引入配置文件：

const dbConfig = require('./config/database');
const envConfig = require('./config/environment');

console.log(dbConfig.development);
console.log(envConfig.development);

通过这种方式，可以根据不同的环境加载相应的配置。