# Fincity Project

**Repository Path**: lin-who-loves-to-type-code/fincity-project

## Basic Information

- **Project Name**: Fincity Project
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-02
- **Last Updated**: 2024-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Fincity

## 项目背景

## 项目介绍

## 项目结构

该项目采用了React框架，使用了Vite作为构建工具，并使用了TypeScript进行类型检查。项目使用了Redux进行状态管理，使用了Ant Design Mobile作为UI组件库，使用了React Router进行页面路由管理。

## 功能模块

- 登录页
- 首页
- 交友页
- 任务页

## 项目搭建

1.创建项目

```bash
yarn create vite
```

2.eslint、prettier、commitlint、husky的环境配置

3.路由的搭建 react-router-dom

4.状态管理库redux

5.ui框架antd-mobile

6.axios二次封装，接口统一管理

7.页面搭建

## 项目文档

```
fincity
├─ .env                  # 包含通用环境变量，如API密钥或数据库连接字符串。
├─ .env.development     # 开发环境专用的环境变量配置。
├─ .env.production      # 生产环境专用的环境变量配置。
├─ .env.test            # 测试环境专用的环境变量配置。
├─ .eslintrc.cjs        # ESLint的配置文件，用于定义代码规范和静态分析规则。
├─ .git                 # Git版本控制系统的工作目录，包含所有版本控制元数据。
├─ .gitignore           # 列出不应被Git追踪的文件模式，如编译输出或临时文件。
├─ .husky               # 存放Husky Git钩子的目录，用于自动化预提交和提交流程。
├─ .prettierignore      # Prettier的忽略列表，列出不应被Prettier格式化的文件。
├─ .prettierrc          # Prettier的配置文件，用于代码美化和一致性的标准化。
├─ commitlint.config.cjs # Commitlint的配置文件，确保提交消息遵循一定的格式。
├─ index.html           # 主HTML页面，Vite会在此文件中注入动态生成的资源链接。
├─ package-lock.json    # 包含确切的依赖树版本，以保证构建的一致性。
├─ package.json         # Node.js项目的元数据和依赖关系管理文件，包括脚本和依赖项。
├─ public               # 存放静态资源的目录，如图标和非编译的HTML文件。
├─ README.md            # 项目的简介和说明文档，通常包含安装和使用指南。
├─ src                  # 源代码的主要目录。
│  ├─ api               # API调用相关的代码，如与后端服务交互的逻辑。
│  ├─ App.css           # 根组件的CSS样式文件。
│  ├─ App.tsx           # 应用的根组件，可能是React组件的定义。
│  ├─ assets            # 存放应用的静态资产，如图像和字体。
│  │  ├─ images         # 图像文件的子目录。
│  │  └─ styles         # 可能包含额外的CSS或Sass样式文件。
│  ├─ components        # 用户界面的可复用组件。
│  ├─ main.tsx          # 应用的入口点，可能初始化React应用程序。
│  ├─ pages             # 不同路由页面的组件。
│  ├─ router            # 路由配置，可能使用React Router或其他路由库。
│  ├─ store             # 状态管理，如Redux或MobX的store配置。
│  ├─ types             # TypeScript类型定义，用于接口、模型或类型别名。
│  ├─ utils             # 实用函数和辅助方法的集合。
├─ UPDATE.md            # 可能是更新日志或发布说明文档。
├─ vite-env.d.ts        # Vite生成的类型声明文件，用于环境变量的类型安全。
├─ vite.config.ts       # Vite的配置文件，用于自定义构建过程。
└─ yarn.lock            # Yarn的锁定文件，记录了确切的包版本以供重现相同的环境。

```

## 项目运行

```bash
yarn
yarn dev
```

eslint 代码检查

```bash
yarn eslint
```

## 项目打包

```bash
yarn build
```

## 项目部署

```bash

```

## 项目维护

- 代码规范
- 代码审查
- 代码提交规范
- 代码提交信息规范

## 项目贡献

- 代码贡献
- 文档贡献
- 问题反馈

## 项目维护者

- 项目维护者姓名
- 项目维护者联系方式

## 代码提交格式

git commit -m <type>[optional scope]: <description> //注意冒号后面有空格

- type：提交的类型（如新增、修改、更新等）
- optional scope：涉及的模块，可选
- description：任务描述

## 代码提交规范

git commit -m 'feat: 增加 xxx 功能'
git commit -m 'bug: 修复 xxx 功能'

## 项目进度

## 项目计划

## 每日工作

第一天

- 创建项目
- 配置eslint、prettier、commitlint、husky
- 搭建路由
- 搭建状态管理库
- 搭建UI框架
- 接口统一管理
- 页面初始化
- 选项卡配置
- 页面切换
  总结：可以实现页面切换，页面内容正在完善，主要时间花费在搭建项目上