From 6b95a5f9ab3d52298c0a66155a530fa5309fcea8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E6=B1=9F=E8=BE=B0?= Date: Wed, 6 Dec 2023 14:33:53 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E8=8B=B1=E6=96=87?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.en-US.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 8 +++++- 2 files changed, 82 insertions(+), 1 deletion(-) create mode 100644 README.en-US.md diff --git a/README.en-US.md b/README.en-US.md new file mode 100644 index 0000000..c955ec9 --- /dev/null +++ b/README.en-US.md @@ -0,0 +1,75 @@ +

Arco Admin

+ +

An out-of-the-box, feature-rich middle and back-office management system framework, standardized with the latest technology stack.

+
+
+ +English | [简体中文](./README.md) +
+

+ node compatibility + License + node compatibility + Version +

+ +*

📌The project is still under rapid development, stay tuned! Currently usable as a starter template👈🏻

* + +## Features ++ ⚡️ New version built with [Vite 5](https://vitejs.dev) for lightning-fast response in frontend development. ++ 👍🏻 [Vue 3](https://vuejs.org) + officially recommended [Vue Router](https://router.vuejs.org) + [Pinia](https://pinia.vuejs.org) state manager. ++ 🔩 Enterprise-level design ecosystem [ArcoDesign](https://arco.design/) component library by ByteDance. ++ 🎨 [Less](http://lesscss.org/) CSS preprocessor. ++ 📚 Utilizing [i18n](https://github.com/intlify/vue-i18n-next/tree/master/packages/vue-i18n#readme) + [i18n-ally](https://github.com/lokalise/i18n-ally) for a simpler, standardized automated internationalization solution. ++ 🌐 Encapsulated common and convenient request methods based on [Axios](https://axios-http.com). ++ ⌨️ Built-in various business scenario pages, components, and framework support configurations for easy customization. ++ 🧚🏻 Fully adopted the `ESM` standard modular syntax, following the trend in modern frontend development. ++ 📦 Continuously optimized configurations to keep up with updates, deprecations, and merged features of dependencies and `Vite`, ensuring the best bundling optimization. + +## Standards +Enhance code quality, reduce errors, and ensure consistency in the entire project's code style to facilitate easier code quality and style management. + ++ **Code Standards:** [ESLint](https://eslint.org/) + [Stylelint](https://stylelint.io) + [Prettier](https://prettier.io)
+ *Static checking and standardization of code syntax, style, and formatting through predefined standards to ensure code quality and readability* + ++ **Commit Standards:** [Husky](https://typicode.github.io/husky/#/) + [Lint-Staged](https://github.com/okonet/lint-staged) + [Commitlint](https://commitlint.js.org)
+ *Ensure consistent code quality and style for each commit through predefined code style checks, formatting, and message validation upon code submission* + +## Browser Support + +| Edge
Edge | Firefox
Firefox | Chrome
Chrome | Safari
Safari | Samsung
Samsung | Opera
Opera | Electron
Electron | +| --------- | --------- | --------- | --------- | --------- | --------- | --------- | +| >=16| >= 31 | >= 49| >= 31| last 2 versions| >= 36 | last 2 versions + +## Usage +1. Clone this repository +```bash +git clone https://github.com/LIjiAngChen8/arco-admin +``` +2. Install dependencies +```bash +pnpm i +``` +3. Run +```bash +pnpm run dev +``` + +#### VsCode Tools + +| [
Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) | [
ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) |[
Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) |[
i18n Ally](https://marketplace.visualstudio.com/items?itemName=Lokalise.i18n-ally) |[
Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)|[
EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)|[
Vite](https://marketplace.visualstudio.com/items?itemName=antfu.vite)| +| --- | --- | --- | ---| --- | --- | --- | + +## Contributing + +Welcome contributions in any form and assure you that we will carefully consider each and every one of them.

+ + +
+ +## Star + +[![趋势图](https://starchart.cc/LIjiAngChen8/arco-admin.svg)](https://starchart.cc/LIjiAngChen8/arco-admin) + +# License +This project is licensed under the [MIT License](./LICENSE) \ No newline at end of file diff --git a/README.md b/README.md index 6237b94..54c3702 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@

一款开箱即用、功能丰富的中后台管理系统框架，最新技术栈的标准化规范项目。


+ +
+ +简体中文 | [English](./README.en-US.md) +
+

node compatibility License @@ -51,7 +57,7 @@ pnpm i pnpm run dev ``` -### VsCode 扩展推荐 +#### VsCode 扩展推荐 | [
Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) | [
ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) |[
Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) |[
i18n Ally](https://marketplace.visualstudio.com/items?itemName=Lokalise.i18n-ally) |[
Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)|[
EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)|[
Vite](https://marketplace.visualstudio.com/items?itemName=antfu.vite)| | --- | --- | --- | ---| --- | --- | --- |