ImmutableAssign 项目使用教程

1. 项目目录结构及介绍

ImmutableAssign/
├── src/
│   ├── index.js
│   ├── utils.js
│   └── tests/
│       ├── test.js
│       └── ...
├── config/
│   ├── default.json
│   └── custom.json
├── package.json
├── README.md
└── .gitignore

目录结构说明

• src/: 项目的主要源代码目录。
  • index.js: 项目的入口文件。
  • utils.js: 包含项目中使用的工具函数。
  • tests/: 包含项目的测试文件。
• config/: 项目的配置文件目录。
  • default.json: 默认配置文件。
  • custom.json: 自定义配置文件。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

src/index.js

index.js 是项目的入口文件，负责初始化项目并启动应用。以下是文件的主要内容：

const ImmutableAssign = require('./utils');
const config = require('../config/default.json');

// 初始化项目
const init = () => {
    console.log('项目初始化完成');
};

// 启动应用
const start = () => {
    console.log('应用启动中...');
    ImmutableAssign.applyConfig(config);
    console.log('应用启动完成');
};

init();
start();

功能说明

• 初始化项目: init() 函数负责项目的初始化工作。
• 启动应用: start() 函数负责启动应用，并应用配置文件中的配置。

3. 项目的配置文件介绍

config/default.json

default.json 是项目的默认配置文件，包含项目启动时所需的默认配置。以下是文件的主要内容：

{
    "port": 3000,
    "database": {
        "host": "localhost",
        "port": 5432,
        "name": "mydb"
    },
    "logging": {
        "level": "info"
    }
}

config/custom.json

custom.json 是项目的自定义配置文件，用于覆盖默认配置。以下是文件的主要内容：

{
    "port": 8080,
    "database": {
        "host": "customhost",
        "port": 5433
    }
}

配置文件说明

• port: 应用的监听端口。
• database: 数据库连接配置。
  • host: 数据库主机地址。
  • port: 数据库端口。
  • name: 数据库名称。
• logging: 日志配置。
  • level: 日志级别。

通过以上配置文件，可以灵活地调整项目的运行参数。