Skip to content

README_EN.md

Latest commit

 

History

History
74 lines (48 loc) · 2.42 KB

README_EN.md

File metadata and controls

74 lines (48 loc) · 2.42 KB
Raw

react-shadcn-admin

English | 简体中文

An open-source, modern, and extensible full-stack admin framework created and maintained by CoreRCE.

Introduction

react-shadcn-admin combines a React admin interface, a Go API, and SQLite persistence. Use it to build an admin system quickly or as a starting point for a full-stack project.

Features

  • Ready to use: Start with a complete frontend and backend project structure
  • User management: Create, edit, enable, disable, reset passwords, and delete users
  • Themes: Switch between light, dark, and system themes
  • Multilingual: Built-in English and Simplified Chinese interfaces
  • Easy to extend: Add pages and business features through a clear project structure
  • Clear feedback: Consistent error messages and common status pages

Installation & Usage

Requirements: Node.js 24+, pnpm 11+, and Go 1.26+.

git clone https://github.com/CoreRCE/react-shadcn-admin.git
cd react-shadcn-admin
make install
make dev-backend

Start the frontend in another terminal:

make dev-frontend

The frontend runs at http://localhost:5173 and the backend at http://127.0.0.1:8080 by default. On Windows without Make, run the equivalent commands from the Makefile.

Contributing

  1. Fork the repository and create a feature branch.
  2. Implement your change with appropriate tests, then run make check and make test.
  3. Open a pull request describing the purpose of the change and how it was verified.

Search existing issues before opening a new one. Do not disclose security issues publicly; contact the maintainer directly.

Git Commit Convention

Commit messages follow Conventional Commits:

feat: add a feature
fix: resolve a bug
docs: update documentation
refactor: restructure code
test: update tests
chore: maintain the project

Keep each commit focused on one clear topic and use a short imperative description.

Maintainer

Star History

Star History Chart

If this project helps you, consider giving it a Star.

License

Official source: CoreRCE/react-shadcn-admin. This project is released under the MIT License.