CWG React Starter 使用教程

1. 项目介绍

CWG React Starter 是一个预配置且开箱即用的 React 启动器应用。它旨在为新项目节省设置时间，几乎所有需要的内容都已经配置好。只需克隆并开始开发，无需在每个项目中重复相同的设置工作。

主要特点

• 预配置: 包括 Axios 拦截器、Redux 与 Redux-Thunk、路由与私有路由、SCSS/SASS 配置、Eslint 与 Prettier、预提交钩子等。
• 绝对导入: 使用绝对导入风格，提高代码可读性。
• 模块化结构: 项目结构按类型组织，便于维护和搜索。

2. 项目快速启动

2.1 克隆项目

首先，克隆 CWG React Starter 项目到本地：

git clone https://github.com/gkhan205/cwg-react-starter.git

2.2 安装依赖

进入项目目录并安装依赖：

cd cwg-react-starter
npm install
# 或者使用 yarn
yarn install

2.3 启动开发服务器

安装完成后，启动开发服务器：

npm start
# 或者使用 yarn
yarn start

开发服务器启动后，访问 http://localhost:3000 即可查看应用。

3. 应用案例和最佳实践

3.1 使用 Create React App 模板

CWG React Starter 也可以作为 Create React App 的模板使用。只需运行以下命令：

npx create-react-app <app-name> --template cwg-react

3.2 模块化开发

项目结构按模块化组织，每个模块/特性都有其相关的文件。例如，src/modules/Dashboard/ 目录下包含了 Dashboard 模块的所有相关文件。

3.3 使用绝对导入

为了提高代码可读性，建议使用绝对导入风格。例如：

import React from 'react';
import uniqBy from 'lodash';
import AppNavbar from 'library/common/components/AppNavbar';
import './style.scss';

4. 典型生态项目

4.1 Redux 与 Redux-Thunk

CWG React Starter 集成了 Redux 和 Redux-Thunk，方便进行状态管理。Redux 的配置文件位于 src/main/store/ 目录下。

4.2 Axios 拦截器

项目中配置了 Axios 拦截器，用于处理 HTTP 请求和响应。Axios 的配置文件位于 src/main/axios/ 目录下。

4.3 路由与私有路由

项目中使用了 React Router 进行路由管理，并配置了私有路由。路由配置文件位于 src/main/routes/ 目录下。

通过以上步骤，您可以快速上手并使用 CWG React Starter 进行开发。希望这个教程对您有所帮助！