diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..0f5a52f432fd1e1b03010a8bb1b6b4a5851c3ded --- /dev/null +++ b/README.en.md @@ -0,0 +1,33 @@ +# Taro-Autoclean Project Documentation + +## Project Introduction +Taro-Autoclean is a car wash service mini-program project based on the Taro framework. Its main features include vehicle management, address management, appointment booking, order management, coupons, and a user center. + +## Project Structure +- `src/apis/`: Modules for interacting with backend APIs, such as address, vehicle, product, order, and user modules. +- `src/components/`: Reusable UI components, such as time pickers and popup selectors. +- `src/hooks/`: React custom hooks for logic reuse and state management. +- `src/pages/`: Code for each mini-program page, such as the home page, order page, and user center. +- `src/styles/`: Style files, including SCSS and Tailwind CSS configurations. +- `src/stores/`: State management modules. +- `src/utils/`: Utility functions, such as formatting and storage tools. + +## Technology Stack +- Cross-platform development framework based on Taro. +- React as the primary development framework. +- SCSS and Tailwind CSS for styling. +- TypeScript for type definitions. + +## Usage Instructions +1. After downloading the code, install dependencies using `npm` or `yarn`. +2. Configure `.env.development`, `.env.production`, and `.env.test` based on your environment. +3. Use `taro build` to build the project and `taro start` to launch the development server. +4. Run the mini-program using an IDE or CLI tool. + +## Contribution Guidelines +- Please fork this project and clone it to your local machine. +- Create a new branch and make your changes. +- Submit a Pull Request, ensuring all tests pass. + +## License +This project is licensed under the MIT License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..3fef30e5b591f1a17dd50676053984b4099b3791 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ + + +# Taro-Autoclean 项目说明 + +## 项目简介 +Taro-Autoclean 是一个基于 Taro 框架的洗车服务小程序项目,主要功能包括车辆管理、地址管理、预约下单、订单管理、优惠券、用户中心等。 + +## 项目结构 +- `src/apis/`:包含与后端 API 交互的模块,如地址、车辆、商品、订单、用户等。 +- `src/components/`:可复用的 UI 组件,例如时间选择器、弹窗选择器等。 +- `src/hooks/`:React 自定义 hooks,用于逻辑复用和状态管理。 +- `src/pages/`:小程序各页面代码,如首页、订单页、用户中心等。 +- `src/styles/`:样式文件,包括 SCSS 和 Tailwind CSS 配置。 +- `src/stores/`:状态管理模块。 +- `src/utils/`:工具函数,如格式化、存储工具等。 + +## 技术栈 +- 基于 Taro 的跨端开发框架。 +- 使用 React 作为主要开发框架。 +- 样式处理使用 SCSS 和 Tailwind CSS。 +- 使用 TypeScript 进行类型定义。 + +## 使用说明 +1. 下载代码后,使用 `npm` 或 `yarn` 安装依赖。 +2. 根据环境配置 `.env.development`, `.env.production`, `.env.test`。 +3. 使用 `taro build` 构建项目,`taro start` 启动开发服务器。 +4. 通过 IDE 或 CLI 工具运行小程序。 + +## 贡献指南 +- 请 Fork 本项目,并 Clone 到本地。 +- 创建新的分支并进行修改。 +- 提交 Pull Request,并确保测试通过。 + +## 授权协议 +本项目遵循 MIT 授权协议。 \ No newline at end of file