Cherry 项目使用教程

Cherry 项目使用教程

cherryCherry is a self-hostable bookmark service项目地址:https://gitcode.com/gh_mirrors/cherry3/cherry

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

Cherry 项目的目录结构如下：

cherry/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── index.js
│   ├── controllers/
│   │   ├── home.js
│   ├── models/
│   │   ├── user.js
├── public/
│   ├── index.html
│   ├── styles.css
├── tests/
│   ├── home.test.js

目录结构介绍

• README.md: 项目说明文件。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录。
    • index.js: 路由入口文件。
  • controllers/: 控制器文件目录。
    • home.js: 主页控制器文件。
  • models/: 数据模型文件目录。
    • user.js: 用户模型文件。
• public/: 静态资源目录。
  • index.html: 主页HTML文件。
  • styles.css: 样式文件。
• tests/: 测试文件目录。
  • home.test.js: 主页测试文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。该文件主要负责初始化应用和启动服务器。

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

app.use(express.static('public'));
app.use('/', require('./routes'));

const port = process.env.PORT || config.get('port');
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

启动文件介绍

• 引入 express 模块并创建应用实例。
• 加载配置文件并获取端口配置。
• 设置静态资源目录。
• 加载路由文件。
• 启动服务器并监听指定端口。

3. 项目的配置文件介绍

项目的配置文件位于 src/config/ 目录下，主要包括 default.json 和 production.json。

default.json

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "cherry"
  }
}

production.json

{
  "port": 8080,
  "database": {
    "host": "production-db-host",
    "port": 27017,
    "name": "cherry-production"
  }
}

配置文件介绍

• default.json: 默认配置文件，包含开发环境的配置信息。
• production.json: 生产环境配置文件，包含生产环境的配置信息。

配置文件中主要包含端口和数据库的配置信息，可以根据不同环境进行相应的配置。

cherryCherry is a self-hostable bookmark service项目地址:https://gitcode.com/gh_mirrors/cherry3/cherry