docs: preserve upstream English README
This commit is contained in:
+104
@@ -0,0 +1,104 @@
|
||||
<img src="https://www.qiniu.lingchen.kim/github-cover-light6.webp" />
|
||||
|
||||
<br />
|
||||
<h1 align="center">Art Design Pro</h1>
|
||||
<p align="center">A backend system template that combines design aesthetics with efficient development, helping you quickly build professional-grade applications</p>
|
||||
<div align="center">English | <a href="./README.zh-CN.md">简体中文</a></div>
|
||||
|
||||
<br />
|
||||
<div align="center">
|
||||
|
||||
[](./LICENSE) [](https://github.com/Daymychen/art-design-pro/stargazers) [](https://github.com/Daymychen/art-design-pro/network/members)
|
||||
|
||||
</div>
|
||||
<br />
|
||||
|
||||
## What makes this project special?
|
||||
|
||||
**Interface Design**: Modern UI design with smooth interactions, focusing on user experience and visual design
|
||||
|
||||
**Quick Start**: Clean architecture + comprehensive documentation, easy for backend developers to use
|
||||
|
||||
**Rich Components**: Built-in high-quality components for data display, forms, and more to meet different business scenarios
|
||||
|
||||
**Smooth Interactions**: Button clicks, theme switching, page transitions, chart animations - experience comparable to commercial products
|
||||
|
||||
**Efficient Development**: Built-in practical APIs like useTable and ArtForm to significantly improve development efficiency
|
||||
|
||||
**Clean Scripts**: Built-in one-click cleanup script to quickly remove demo data and get a ready-to-develop base project
|
||||
|
||||
## Tech Stack
|
||||
|
||||
Development Framework: Vue3, TypeScript, Vite, Element-Plus, Tailwind CSS
|
||||
|
||||
Code Standards: Eslint, Prettier, Stylelint, Husky, Lint-staged, cz-git
|
||||
|
||||
## Preview
|
||||
|
||||
<kbd><img src="https://www.qiniu.lingchen.kim/github-c1.webp" alt="Light Theme"/></kbd>
|
||||
|
||||
<kbd><img src="https://www.qiniu.lingchen.kim/github-c2.webp" alt="Light Theme"/></kbd>
|
||||
|
||||
<kbd><img src="https://www.qiniu.lingchen.kim/github-c4.webp" alt="Dark Theme"/></kbd>
|
||||
|
||||
<kbd><img src="https://www.qiniu.lingchen.kim/github-c5.webp" alt="Dark Theme"/></kbd>
|
||||
|
||||
## Quick Access
|
||||
|
||||
[Live Demo](https://www.artd.pro) | [Official Documentation](https://www.artd.pro/docs) | [Changelog](./CHANGELOG.en.md)
|
||||
|
||||
## Installation & Setup
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
# If pnpm install fails, try using the command below
|
||||
pnpm install --ignore-scripts
|
||||
|
||||
# Start local development environment
|
||||
pnpm dev
|
||||
|
||||
# Build for production
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## Clean Version
|
||||
|
||||
The project includes a cleanup script to quickly remove demo data and provide developers with a ready-to-develop base project
|
||||
|
||||
```bash
|
||||
pnpm clean:dev
|
||||
```
|
||||
|
||||
## Technical Support
|
||||
|
||||
QQ Group: <a href="https://qm.qq.com/cgi-bin/qm/qr?k=Gg6yzZLFaNgmRhK0T5Qcjf7-XcAFWWXm&jump_from=webapi&authKey=YpRKVJQyFKYbGTiKw0GJ/YQXnNF+GdXNZC5beQQqnGZTvuLlXoMO7nw5fNXvmVhA">1038930070</a> (Click the link to join the group chat)
|
||||
|
||||
## Browser Compatibility
|
||||
|
||||
Supports modern mainstream browsers including Chrome, Safari, Firefox, and more.
|
||||
|
||||
## Contributing
|
||||
|
||||
We sincerely welcome and appreciate the support of every contributor! Whether you have new ideas, feature suggestions, or code optimizations, you can participate in the following ways:
|
||||
|
||||
Submit Pull Requests: Share your code and help the project grow.
|
||||
|
||||
Create GitHub Issues: Provide bug feedback or new feature suggestions to help us improve together.
|
||||
|
||||
Every contribution you make takes this project one step further! Come join our open source community!
|
||||
|
||||
## Continuous Optimization & Extension
|
||||
|
||||
The project maintains active updates, supports the latest frontend tech stack, is compatible with mainstream frameworks, and ensures long-term stability and extensibility. Community-driven feedback mechanisms allow your needs to be quickly integrated into project iterations.
|
||||
|
||||
## Donation
|
||||
|
||||
If you feel this project has reduced your development costs and solved problems in your work/life, you can support us through the following ways:
|
||||
|
||||
<img src="https://www.qiniu.lingchen.kim/%E7%BB%84%202%402x%202.png" alt="Donation QR Code"/>
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://www.star-history.com/#Daymychen/art-design-pro&Date)
|
||||
Reference in New Issue
Block a user