-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
82 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| <h1 align="center">Arco Admin</h1> | ||
|
|
||
| <p align="center">An out-of-the-box, feature-rich middle and back-office management system framework, standardized with the latest technology stack.</p> | ||
| <br/> | ||
| <div align="center"> | ||
|
|
||
| English | [简体中文](./README.md) | ||
| </div> | ||
| <p align="center"> | ||
| <a href="https://nodejs.org/en/about/previous-releases"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatibility"></a> | ||
| <img alt="License" src="https://img.shields.io/github/license/LIjiAngChen8/arco-admin"> | ||
| <img src="https://img.shields.io/github/last-commit/LIjiAngChen8/arco-admin.svg" alt="node compatibility"> | ||
| <img alt="Version" src="https://img.shields.io/github/package-json/v/LIjiAngChen8/arco-admin/main"> | ||
| </p> | ||
|
|
||
| *<p align="center">📌The project is still under rapid development, stay tuned! Currently usable as a starter template👈🏻</p>* | ||
|
|
||
| ## 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)<br/> | ||
| *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)<br/> | ||
| *Ensure consistent code quality and style for each commit through predefined code style checks, formatting, and message validation upon code submission* | ||
|
|
||
| ## Browser Support | ||
|
|
||
| | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" /><br/>Edge | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" /><br/>Firefox | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" /><br/>Chrome | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" /><br/>Safari | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/samsung-internet/samsung-internet_48x48.png" alt="Samsung" width="24px" height="24px" /><br/>Samsung | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" /><br/>Opera | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" /><br/>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 | ||
|
|
||
| | [<img src="https://vue.gallerycdn.vsassets.io/extensions/vue/volar/1.8.24/1701250883040/Microsoft.VisualStudio.Services.Icons.Default" width="24px" height="24px" /><br>Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) | [<img src="https://dbaeumer.gallerycdn.vsassets.io/extensions/dbaeumer/vscode-eslint/2.4.2/1687441427519/Microsoft.VisualStudio.Services.Icons.Default" width="24px" height="24px" /><br>ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) |[<img src="https://esbenp.gallerycdn.vsassets.io/extensions/esbenp/prettier-vscode/10.1.0/1690819498575/Microsoft.VisualStudio.Services.Icons.Default" width="24px" height="24px" /><br>Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) |[<img src="https://lokalise.gallerycdn.vsassets.io/extensions/lokalise/i18n-ally/2.12.0/1695476646920/Microsoft.VisualStudio.Services.Icons.Default" width="24px" height="24px" /><br>i18n Ally](https://marketplace.visualstudio.com/items?itemName=Lokalise.i18n-ally) |[<img src="https://stylelint.gallerycdn.vsassets.io/extensions/stylelint/vscode-stylelint/1.3.0/1698920117910/Microsoft.VisualStudio.Services.Icons.Default" width="25px" height="25px" /><br>Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)|[<img src="https://editorconfig.gallerycdn.vsassets.io/extensions/editorconfig/editorconfig/0.16.4/1607315835386/Microsoft.VisualStudio.Services.Icons.Default" width="25px" height="25px" /><br>EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)|[<img src="https://antfu.gallerycdn.vsassets.io/extensions/antfu/vite/0.2.5/1622972526798/Microsoft.VisualStudio.Services.Icons.Default" width="25px" height="25px" /><br>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.<br/><br/> | ||
|
|
||
| <a href="https://github.com/LIjiAngChen8/arco-admin/graphs/contributors"><img src="https://contrib.rocks/image?repo=LIjiAngChen8/arco-admin" /> | ||
| </a><br/> | ||
|
|
||
| ## Star | ||
|
|
||
| [](https://starchart.cc/LIjiAngChen8/arco-admin) | ||
|
|
||
| # License | ||
| This project is licensed under the [MIT License](./LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters