Weferral 项目安装与使用指南-CSDN博客

Weferral 项目安装与使用指南

1. 项目目录结构及介绍

Weferral 项目的目录结构如下：

weferral/
├── app/
│   ├── build/
│   ├── config/
│   ├── debug/
│   ├── log/
│   ├── src/
│   └── ...
├── .babelrc
├── .eslintrc
├── .gitignore
├── .npmrc
├── LICENSE
├── README.md
├── package.json
└── postcss.config.js

目录结构介绍

app/: 项目的主要代码目录，包含前端和后端的源代码。
- build/: 构建输出目录，包含编译后的文件。
- config/: 配置文件目录，包含项目的各种配置文件。
- debug/: 调试相关文件目录。
- log/: 日志文件目录。
- src/: 源代码目录，包含前端和后端的源代码文件。
.babelrc: Babel 配置文件，用于 JavaScript 代码的转译。
.eslintrc: ESLint 配置文件，用于代码风格检查。
.gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
.npmrc: npm 配置文件，用于配置 npm 的行为。
LICENSE: 项目许可证文件。
README.md: 项目说明文件，包含项目的概述、安装和使用说明。
package.json: 项目的 npm 配置文件，包含项目的依赖、脚本等信息。
postcss.config.js: PostCSS 配置文件，用于 CSS 预处理。

2. 项目启动文件介绍

Weferral 项目的启动文件主要位于 app/src/ 目录下。以下是主要的启动文件：

app/src/index.js: 前端项目的入口文件，负责初始化 React 应用并启动前端服务。
app/src/server.js: 后端项目的入口文件，负责启动 Node.js 服务器并监听端口。

启动步骤

前端启动:
```
cd weferral
npm install
npm start
```
后端启动:
```
cd weferral-api
npm install
npm start
```

3. 项目配置文件介绍

Weferral 项目的配置文件主要位于 app/config/ 目录下。以下是主要的配置文件：

app/config/default.js: 默认配置文件，包含项目的默认配置项。
app/config/production.js: 生产环境配置文件，包含生产环境下的配置项。
app/config/development.js: 开发环境配置文件，包含开发环境下的配置项。

配置文件示例

// app/config/default.js
module.exports = {
  port: 4100,
  database: {
    host: 'localhost',
    user: 'root',
    password: '',
    name: 'weferral'
  },
  // 其他配置项...
};