English | 中文

Brief Introduction

The out of the box background template developed based on mainstream technologies such as React18,And Design,Vite4, and the built-in internationalization, routing permission control and other solutions can meet the needs of most enterprise management systems!

Characteristic

• The latest technology stack: Developed using front-end cutting-edge technologies such as React18/Vite4

• Theme: configurable theme

• Internationalization: built-in perfect internationalization scheme

• Permission: Permission Routing

Preview

• github site
• gitee site

Prepare

• Node And Git - Project development environment
• Vite - Familiar with Vite features
• React18 - Familiar with the basic syntax of React18
• Es6+ - familiar with the basic syntax of Es6
• React Router V6 - Familiar with the basic use of React Router V6
• And Design 5 - Ui basic use
• Emotion - Basic use

Installation and use

1. Get project code (Https or SSH)

git clone https://github.com/jsxiaosi/react-xs-admin.git

git clone [email protected]:jsxiaosi/react-xs-admin.git

Alternatively, you can use the xs-clito quickly create one

npx @jsxiaosi/xs-cli create [project-name]

2.Installation Dependencies

cd react-xs-admin

Recommendedpnpm

pnpm i

npm install

npm install

3.Developer

npm run dev

4.Production

npm run build

Project address

• react-xs-admin

How to contribute

Pull Request:

1. Fork Code!
2. Create your own branch: git checkout -b feature/xxxx
3. Submit your changes: git commit -m 'feature: add xxxxx'
4. Push your branch: git push origin feature/xxxx
5. Submit: pull request

Git Contribution submission specification

• Refer to Vue specification

  • feat New Features
  • fix Repair defects
  • docs Document change
  • style Code format
  • refactor Code refactoring
  • perf Performance optimization
  • test Add neglected tests or changes to existing tests
  • build Build processes, external dependency changes (such as upgrading npm packages, modifying packaging configurations, etc.)
  • ci Modify CI configuration and scripts
  • revert Roll back the commit
  • chore Changes to the build process or tools and libraries (do not affect source files)
  • wip Under development
  • types Type definition file modification

Browser Support

Chrome 80+ is recommended for local development

Supports modern browsers, not Internet Explorer

IE	Edge	Firefox	Chrome	Safari
not support	last 2 versions	last 2 versions	last 2 versions	last 2 versions

maintainers

@jsxiaosi

License

MIT © 2022