README.en-US.md

vue-pure-admin

English | 中文

Introduction

vue-pure-admin is an open source free and out-of-the-box middle and background management system template. Developed using the latest mainstream technologies such as Vue3, Vite, Element-Plus, TypeScript, Pinia, Tailwindcss

Thin version (offering non-internationalized and internationalized versions)

The simplified version is based on the shelf extracted from vue-pure-admin, which contains main functions and is more suitable for actual project development. The packaged size is introduced globally element-plus is still below 2.3MB, and the full version of the code will be permanently synchronized. After enabling brotli compression and cdn to replace the local library mode, the package size is less than 350kb

• Click me to view the non-internationalized version
• Click me to view Internationalization version

Supporting Video

• Click Watch Tutorial
• Click Watch UI Design

Docs

• documentation site

Tauri

• Click Watch Tauri

Electron

• Click Watch Electron

Preview

• preview station

• PC

• DarkMode

• Mobile

Use Gitpod

Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.

Install and use

• Get the project code

git clone https://github.com/pure-admin/vue-pure-admin.git
or
git clone https://gitee.com/yiming_chang/vue-pure-admin.git

• Installation dependencies

cd vue-pure-admin

pnpm install

• run

pnpm serve

• build

pnpm build

Docker support

1. Customize the image named vue-pure-admin (please note that there is a dot . at the end of the command below, indicating that the Dockerfile file in the current path is used, and the path can be specified according to the actual situation)

docker build -t vue-pure-admin .

2. Port mapping and start the docker container (8080:80: indicates that the 80 port is used in the container, and the port is forwarded to the 8080 port of the host; pure-admin: indicates a custom container name; vue-pure-admin: indicates the custom image name)

docker run -dp 8080:80  --name pure-admin vue-pure-admin

After operating the above two commands, open http://localhost:8080 in the browser to preview

Of course, you can also operate the docker project through the Docker Desktop visual interface, as shown below

Change Log

CHANGELOG

How to contribute

You are very welcome to join！Raise an issue Or submit a Pull Request

Pull Request:

1. Fork code!
2. Create your own branch: git checkout -b feat/xxxx
3. Submit your changes: git commit -am 'feat(function): add xxxxx'
4. Push your branch: git push origin feat/xxxx
5. submitpull request

Git Contribution submission specification

• reference vue specification (Angular)

  • feat Add new features
  • fix Fix the problem/BUG
  • style The code style is related and does not affect the running result
  • perf Optimization/performance improvement
  • refactor Refactor
  • revert Undo edit
  • test Test related
  • docs Documentation/notes
  • chore Dependency update/scaffolding configuration modification etc.
  • workflow Workflow improvements
  • ci Continuous integration
  • types Type definition file changes
  • wip In development

Browser support

The Chrome 80+ browser is recommended for local development

Support modern browsers, not IE

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

Maintainer

xiaoxian521、Ten-K

License

In principle, no fees and copyrights are charged, and it is commercially available, but if you need secondary open source (such as using this platform for secondary development and open source, the front-end code must be open source and free), please contact the author for permission! (Free, just take a record)

MIT © 2020-present, pure-admin

Star

Many thanks to the kind individuals who leave a star. Your support is much appreciated ❤️

Fork

It's so cool that you study hard ❤️