Skip to content

Latest commit

 

History

History
176 lines (128 loc) · 6.27 KB

README-en.md

File metadata and controls

176 lines (128 loc) · 6.27 KB
Ace Admin

Ace Admin

中文 | English

⚡ Introduction

Ace (no need to say more-.-) aims to build a free and open-source mid-small size backend management system, based on the latest Vue3.4 ecosystem and other mainstream technologies.(: Ready to use out of the box, no complex packaging, supports secondary development. (Currently writing Java backend, other language versions may be written later.)

Ace Admin is a free and open-source backend management system solution built using cutting-edge technology stacks like Vue3.4, TypeScript5.x, Antd-Vue4.x, Pinia2.x, and Vite5.x. The project data is implemented via ApiFox simulation. Based on the exquisite theme of Antd4, I have constructed a clear and efficient project logic structure, integrating the latest technology frameworks. Welcome to use!

📚 Documentation

  • User Documentation: doc

📺 Online Demo

Location Account Password Link
vercel [email protected] admin666 Link

❤️ Powered by Love

  • Completely Free: But I hope you give a star ⭐!!!
  • Very Simple: No complex packaging, no complex type gymnastics, ready to use out of the box
  • Detailed Comments: As detailed comments as possible for each configuration item
  • Latest Dependencies: Regular updates of all third-party dependencies to the latest version
  • A Bit of Regularity: Unified code style, naming style, and comment style

📖 Project Highlights

  • Cutting-edge Technology: The latest around Vue 3.4 ecosystem.
  • Simple git hooks: Recommended by Evan You (can replace husky).
  • Antd-Vue: Using the more exquisite Ant-Design-Vue 4.x version.
  • Pinia: The legendary Vuex5, integrated with Pinia persistence plugin.
  • Vite: The latest Vite5.x, a modern build tool known for its speed (multi-environment).
  • Vue Router: Manages routes.
  • TypeScript: A static type scheme that goes beyond traditional JavaScript.
  • Pnpm: A fast and space-saving package management tool.
  • Scss: Used to customize layouts and color styles.
  • ESLint & Prettier: Code verification and formatting tools.
  • Axios: Networking library (elegantly encapsulated).
  • Mobile Compatibility: Layout compatible with mobile page resolutions (under development).

📔 Features

  • User Management: Login, logout demonstration
  • Permission Management: Built-in page permissions (dynamic routes), route guards, directive permissions, permission functions (coding)
  • Hooks: Commonly used hooks encapsulation
  • Multi-environment: Support for development, pre-release, and production environments.
  • Multiple Themes: Built-in normal, dark, and custom theme modes.
  • Multiple Layouts: Built-in left-side, top-side layout modes.
  • Error Pages: Error handling pages, such as 403, 404.
  • Dashboard: Customized display based on user roles.
  • Other Built-in Features: Such as SVG, dynamic sidebar, dynamic breadcrumbs, tabbed navigation, Screenfull full screen, responsive sidebar, etc.

🚀 Usage Guide

Pre-configuration

  1. Environment Setup
  2. Recommended node version 18+/20+
  3. Recommended pnpm version 8.x+
# Clone the project
git clone https://github.com/xoxosos/vue-ace-admin.git
# Enter the project directory
cd vue-ace-admin
# Install pnpm (skip if already installed)
npm install pnpm -g
# Install dependencies
pnpm i
# Start the service
pnpm dev

🔧 Code Checking

# Code check and formatting, just run the corresponding command.
pnpm lint

✔️ Preview

# Preview the production environment
pnpm preview

📦️ Multi-environment Packaging

# Build for pre-release environment
pnpm build:test
# Build for production environment
pnpm build:prod

Contribute

We are very welcome to have you participate in our open source project.

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

Thank you to all the people who already contributed to ace-admin!

✒️ Git Commit Conventions Reference

Git commit conventions include common commit types that help developers track and manage changes more effectively.

  • Refer to vue conventions (Angular)

    • feat for new features
    • fix for bug fixes
    • style for code style related changes (no impact on code operation)
    • perf for performance improvements
    • refactor for refactorings
    • revert for reverting changes
    • test for tests
    • docs for documentation and comments
    • chore for maintenance tasks
    • workflow for workflow improvements
    • ci for continuous integration
    • types for type definition changes
    • wip for work in progress

🖥️ Project Preview Image

blob

🌏 Browser Support

For local development, modern browsers such as Chrome 80+ are recommended.

IE is not supported.

💕 Thanks for the Star

If you like this project, please don’t hesitate to give a ⭐star as a token of appreciation. This motivates the maintainer to continue updating. (Whispering: after all, it's free)

📄 License

This project is licensed under the MIT License. Copyright belongs to CodexLin.

Copyright (c) 2023-Present CodexLin