{"id":13417008,"url":"https://github.com/jsxiaosi/vue-xs-admin","last_synced_at":"2025-04-05T13:03:41.165Z","repository":{"id":37387771,"uuid":"466678539","full_name":"jsxiaosi/vue-xs-admin","owner":"jsxiaosi","description":"Vue3+TypeScript+Vite搭建的开箱即用后台模板","archived":false,"fork":false,"pushed_at":"2024-12-28T12:23:43.000Z","size":24150,"stargazers_count":125,"open_issues_count":0,"forks_count":27,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-29T12:03:50.188Z","etag":null,"topics":["element-plus","pinia","typescript","vite","vitejs","vue3","vue3-admin","vuerouter"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsxiaosi.png","metadata":{"files":{"readme":"README.EN.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-06T08:26:29.000Z","updated_at":"2025-03-27T08:35:38.000Z","dependencies_parsed_at":"2023-11-28T14:25:12.930Z","dependency_job_id":"6faa4eac-1c66-4736-b7ca-dd7197edbac4","html_url":"https://github.com/jsxiaosi/vue-xs-admin","commit_stats":{"total_commits":375,"total_committers":2,"mean_commits":187.5,"dds":0.005333333333333301,"last_synced_commit":"8bc9ee46b2b101a3574ed1edbf5ca4a8e0c0c545"},"previous_names":[],"tags_count":18,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxiaosi%2Fvue-xs-admin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxiaosi%2Fvue-xs-admin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxiaosi%2Fvue-xs-admin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsxiaosi%2Fvue-xs-admin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsxiaosi","download_url":"https://codeload.github.com/jsxiaosi/vue-xs-admin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247339153,"owners_count":20923014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["element-plus","pinia","typescript","vite","vitejs","vue3","vue3-admin","vuerouter"],"created_at":"2024-07-30T22:00:31.122Z","updated_at":"2025-04-05T13:03:41.146Z","avatar_url":"https://github.com/jsxiaosi.png","language":"Vue","funding_links":[],"categories":["Get Started"],"sub_categories":["Templates"],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://github.com/jsxiaosi/vue-xs-admin\"\u003e\n\u003ch1\u003evue-xs-admin\u003c/h1\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\n**English** | [中文](./README.md)\n\n## Brief Introduction\n\nThe out of the box background template developed based on mainstream technologies such as `Vue3`、`Vite3`、`Element Plus`, built-in `I18n` translation, routing permission control and other solutions can meet the needs of most enterprise management systems!\n\n## Preview address\n\n- [github site](https://jsxiaosi.github.io/vue-xs-admin/)\n- [gitee site](http://jsxiaosi.gitee.io/vue-xs-admin)\n\nAccount: admin  \nPassword: admin123\n\n## Document\n\n- [github site](https://jsxiaosi.github.io/vue-xs-admin-docs/)\n- [gitee site](https://jsxiaosi.gitee.io/vue-xs-admin-docs)\n\n## Simple version\n\n- [mini-xs-admin](https://github.com/jsxiaosi/mini-xs-admin)\n\n## Electron Edition\n\n- [electron-xs-admin](https://github.com/jsxiaosi/electron-xs-admin)\n\n## Tauri Edition\n\n- [tauri-xs-admin](https://github.com/jsxiaosi/tauri-xs-admin)\n\n## Characteristic\n\n- **The latest technology stack**: developed using front-end cutting-edge technologies such as Vue3/Vite3\n\n- **Theme**: configurable theme\n\n- **Internationalization**: built-in perfect internationalization scheme\n\n- **Common components**: complete built-in package of common components\n\n- **PWA**: built-in PWA\n\n## Prepare\n\n- [Node](http://nodejs.org/) And [Git](https://git-scm.com/) - Project development environment\n- [Vite](https://cn.vitejs.dev/) - Familiar with Vite features\n- [Vue3](https://v3.cn.vuejs.org/) - familiar with Vue basic syntax\n- [Es6+](http://es6.ruanyifeng.com/) - familiar with the basic syntax of Es6\n- [Vue-Router-Next](https://next.router.vuejs.org/zh/) - Familiar with the basic use of Vue Router\n- [Element-Plus](https://element-plus.gitee.io/#/zh-CN/) - Ui Basic Usage\n\n## Installation and use\n\n### 1. Get project code (Https or SSH)\n\n```bash\ngit clone https://github.com/jsxiaosi/vue-xs-admin.git\n\ngit clone git@github.com:jsxiaosi/vue-xs-admin.git\n```\n\nAlternatively, you can use the [`xs-cli`](https://github.com/jsxiaosi/xs-cli)to quickly create one\n\n```bash\nnpx @jsxiaosi/xs-cli create [project-name]\n```\n\n### 2.Installation Dependencies\n\n```bash\ncd vue-xs-admin\n```\n\nRecommended`pnpm`\n\n```bash\npnpm i\n```\n\n`npm` install\n\n```bash\nnpm install\n```\n\n### 3.Developer\n\n```bash\nnpm run dev\n```\n\n### 4.Production\n\n```bash\nnpm run build\n```\n\n## Project address\n\n- [vue-xs-admin](https://github.com/jsxiaosi/vue-xs-admin)\n\n## How to contribute\n\n**Pull Request:**\n\n1. Fork Code!\n2. Create your own branch: `git checkout -b feature/xxxx`\n3. Submit your changes: `git commit -m 'feature: add xxxxx'`\n4. Push your branch: `git push origin feature/xxxx`\n5. Submit: `pull request`\n\n## Git Contribution submission specification\n\n- Refer to [Vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification\n\n  - `feat` New Features\n  - `fix` Repair defects\n  - `docs` Document change\n  - `style` Code format\n  - `refactor` Code refactoring\n  - `perf` Performance optimization\n  - `test` Add neglected tests or changes to existing tests\n  - `build` Build processes, external dependency changes (such as upgrading npm packages, modifying packaging configurations, etc.)\n  - `ci` Modify CI configuration and scripts\n  - `revert` Roll back the commit\n  - `chore` Changes to the build process or tools and libraries (do not affect source files)\n  - `wip` Under development\n  - `types` Type definition file modification\n\n## Browser Support\n\nChrome 80+ is recommended for local development\n\nSupports modern browsers, not Internet Explorer\n\n| [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\" alt=\" Edge\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eIE | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\" alt=\" Edge\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eEdge | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png\" alt=\"Firefox\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eFirefox | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png\" alt=\"Chrome\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eChrome | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png\" alt=\"Safari\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eSafari |\n| :-: | :-: | :-: | :-: | :-: |\n| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |\n\n## Related warehouses used in the project\n\n### Vite related\n\n- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression/) - Resource compression supports gzip or brotli\n\n- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import/) - Dynamically introduce component library styles\n\n- [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons/) - SVG Sprite figure\n- [vite-plugin-theme-preprocessor](https://github.com/GitOfZGT/vite-plugin-theme-preprocessor/) - Change the theme style dynamically\n- [vite-plugin-pwa](https://vite-plugin-pwa.netlify.app/) - PWA\n\n### Specifications related to\n\n- [EsLint](https://eslint.org/) - js Grammar testing\n\n- [StyleLint](https://stylelint.io/) - Style syntax checking\n\n- [CommitLint](https://commitlint.js.org/#/) - git commit Commits a canonical detection\n\n## Project directory Structure\n\n```base\n.\n├── build                         #Global public configuration directory\n├── public                        #Public static file directory\n├── src                           #Project Code Directory\n│   ├── App.vue                   #The vue module\n│   ├── assets                    #Project static file directory\n│   ├── components                #Common components\n│   ├── layouts                   #Layout of the directory\n│   ├── locales                   #Internationalization Configuration\n│   ├── main.js                   #Entrance to the file\n│   ├── router                    #Router\n│   ├── store                     #Pinia\n│   ├── styles                    #Common style\n│   ├── utils                     #Public methods\n│   └── views                     #Directory for storing vue pages\n├── LICENSE\n├── README.md\n├── .editorconfig                 #The specification compiler encodes style files\n├── .env.development              #Development environment variables\n├── .env.production               #Production environment variables\n├── .env.staging                  #Test environment variables\n├── .eslintrc.js                  #EsLint configuration files\n├── .eslintrcignore               #EsLint Ignoring configuration files\n├── stylelint.config.js           #StyleLint configuration files\n├── .stylelintignore              #StyleLint Ignoring configuration files\n├── commitlint.config.js          #CommitLint configuration files\n├── prettier.config.js            #Prettier configuration files\n├── .prettierignore               #Prettier Ignoring configuration files\n├── index.html                    #The root template\n├── jsconfig.json\n├── package-lock.json\n├── package.json\n└── vite.config.js                #vite configuration files\n```\n\n## Thanks to the following author projects for help\n\n- [vue-vben-admin](https://github.com/anncwb/vue-vben-admin)\n- [vue-pure-admin](https://github.com/xiaoxian521/vue-pure-admin)\n- [vue-office](https://github.com/501351981/vue-office)\n\n## maintainers\n\n[@jsxiaosi](https://github.com/jsxiaosi)\n\n## License\n\n[MIT © 2022](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsxiaosi%2Fvue-xs-admin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsxiaosi%2Fvue-xs-admin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsxiaosi%2Fvue-xs-admin/lists"}