开源项目 make-sense 使用教程

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

make-sense 项目的目录结构如下：

make-sense/
├── assets/
├── components/
├── config/
├── hooks/
├── pages/
├── public/
├── services/
├── styles/
├── utils/
├── .gitignore
├── .prettierrc
├── package.json
├── README.md
└── tsconfig.json

• assets/: 存放静态资源文件，如图片、字体等。
• components/: 存放项目中的 React 组件。
• config/: 存放项目的配置文件。
• hooks/: 存放自定义的 React Hooks。
• pages/: 存放页面组件。
• public/: 存放公开的静态文件。
• services/: 存放与后端交互的服务文件。
• styles/: 存放全局样式文件。
• utils/: 存放工具函数。
• .gitignore: Git 忽略文件配置。
• .prettierrc: Prettier 代码格式化配置。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 package.json 中的 start 脚本。通常情况下，启动命令如下：

"scripts": {
  "start": "react-scripts start"
}

运行 npm start 或 yarn start 即可启动开发服务器。

3. 项目的配置文件介绍

项目的配置文件主要存放在 config/ 目录下。以下是一些常见的配置文件：

• config/default.json: 默认配置文件，包含项目的默认设置。
• config/production.json: 生产环境配置文件，包含生产环境的特定设置。
• config/development.json: 开发环境配置文件，包含开发环境的特定设置。

这些配置文件通常使用 config 库进行管理，可以通过 process.env.NODE_ENV 来加载不同的配置文件。

例如，在代码中使用配置：

import config from 'config';

const apiUrl = config.get('apiUrl');

通过这种方式，可以方便地在不同环境中切换配置。