Overview

The react-view-cross-platform is a universal template based on React, designed for building cross-platform projects for mobile, PC, and web. It serves as a foundation for project frameworks. The technology stack includes React 17.x, Redux Toolkit, TypeScript, Less/Scss, ECharts, Ant Design 4.x, Vite 3.x, Cordova, Electron, EsLint, Prettier, Husky, and vConsole for mobile development.

Features

• React: Built with the latest version of React (17.x).
• Redux Toolkit: Utilizes Redux Toolkit for state management.
• TypeScript: Written in TypeScript for improved type checking and scalability.
• Less/Scss: Supports both Less and Scss for styling.
• ECharts: Includes ECharts, a powerful data visualization library.
• Ant Design 4.x: Integrates Ant Design version 4.x for UI components.
• Vite 3.x: Developed using Vite version 3.x for fast and efficient builds.
• Cordova: Provides compatibility with Cordova for building mobile apps.
• Electron: Enables desktop application development with Electron.
• EsLint: Utilizes EsLint for code linting.
• Prettier: Includes Prettier for code formatting.
• Husky: Provides pre-commit hooks with Husky.
• vConsole: Supports the integration of vConsole for mobile debugging.

Installation

To use this template, follow the steps below:

1. Clone the repository:

git clone [repository-url]
cd react-view-cross-platform

2. Install the required dependencies:

npm install

3. To start the development server, run one of the following commands:

• For general development:

npm run dev

• For mobile app development:

npm run dev:app

• For desktop app development:

npm run dev:exe

4. To preview the application, run one of the following commands:

• For general preview:

npm run server

• For mobile app preview:

npm run server:app

• For desktop app preview:

npm run server:exe

5. To build the production-ready application, run one of the following commands:

• For general build:

npm run build

• For mobile app build:

npm run build:app

• For desktop app build:

npm run build:exe

6. To perform code check with EsLint, run the following command:

npm run lint

7. To install the Electron icon handler, use the following command:

npm run install:electron-icon

8. For documentation and reference, check these resources:

• React documentation
• Redux Toolkit documentation
• Vite documentation
• Ant Design documentation
• Ant Design Pro documentation
• React components documentation
• Scss/Less usage guide
• XHttp usage guide
• Xxx usage guide
• Other miscellaneous resources

9. To report issues or contribute by submitting a pull request, contact hxbpandaoh@163.com.

10. For the author’s blog and preview of a small demo, visit the blog of Leo He.

Note: The author emphasizes the importance of documentation in the software development process.

Summary

The react-view-cross-platform is a versatile React-based template that allows for the development of cross-platform projects. It offers a comprehensive technology stack and comes with a rich set of features, including a wide range of libraries and tools. The installation process is straightforward, and the template provides commands for development, preview, and building of the application. It also includes resources for documentation, issue reporting, and contribution.