|
## ๐ ๏ธ Tech Stack
### Backend
### Frontend
### DevOps & Infrastructure
## ๐ Project Structure
```
๐ฆ mcp-rapi/
โโโ ๐ง backend/ # Go Backend Service
โ โโโ ๐ cmd/ # Application Entry Point
โ โ โโโ main.go # Main application
โ โโโ โ๏ธ configs/ # Configuration Files
โ โ โโโ dev.yaml # Development config
โ โ โโโ prod.yaml # Production config
โ โ โโโ casbin_model.conf # Casbin RBAC model
โ โโโ ๐๏ธ internal/ # Internal Application Code
โ โ โโโ ๐ฏ domain/ # Business Domain Layer
โ โ โ โโโ ๐ entity/ # Domain Entities
โ โ โ โโโ ๐๏ธ repository/ # Repository Interfaces
โ โ โ โโโ ๐ง service/ # Business Services
โ โ โโโ ๐ญ infrastructure/ # Infrastructure Layer
โ โ โ โโโ ๐พ cache/ # Redis Cache Implementation
โ โ โ โโโ ๐ฆ container/ # Dependency Injection
โ โ โ โโโ ๐๏ธ database/ # Database Connection
โ โ โ โโโ ๐๏ธ repository/ # Repository Implementation
โ โ โโโ ๐ ๏ธ pkg/ # Internal Utilities
โ โ โโโ ๐ transport/ # Transport Layer
โ โ โโโ ๐ http/ # HTTP Handlers
โ โ โโโ ๐ middleware/ # HTTP Middleware
โ โโโ ๐ pkg/ # Public Utilities
โ โ โโโ casbinx/ # Casbin Extensions
โ โโโ ๐ scripts/ # Utility Scripts
โ โโโ init_admin.go # Admin Initialization
โโโ ๐จ frontend/ # Vue.js Frontend
โ โโโ ๐ public/ # Static Assets
โ โโโ ๐ src/ # Source Code
โ โ โโโ ๐ api/ # API Client
โ โ โโโ ๐ญ assets/ # Assets
โ โ โโโ ๐งฉ components/ # Vue Components
โ โ โโโ ๐บ๏ธ router/ # Vue Router Configuration
โ โ โโโ ๐๏ธ store/ # Vuex Store
โ โ โโโ ๐จ styles/ # Global Styles
โ โ โโโ ๐ ๏ธ utils/ # Utility Functions
โ โ โโโ ๐๏ธ views/ # Vue Views/Pages
โ โโโ ๐ฆ package.json # NPM Dependencies
โ โโโ โ๏ธ vue.config.js # Vue CLI Configuration
โโโ ๐ณ docker-compose.yml # Docker Compose Configuration
โโโ ๐ณ docker-compose.dev.yml # Development Docker Compose
โโโ ๐ .env.example # Environment Variables Template
โโโ ๐จ assets/ # Project Assets
โ โโโ logo.svg # Project Logo
โโโ ๐ docs/ # Documentation
โโโ ๐ deploy/ # Deployment & Container Management
โ โโโ ๐ณ docker-compose.ghcr.yml # GHCR Docker Compose
โ โโโ ๐ง build-and-push.sh # Build & Push Images Script
โ โโโ ๐ deploy-ghcr.sh # GHCR Deployment Script
โ โโโ โ๏ธ .env.production # Production Environment Config
โ โโโ ๐ README.md # Deployment Guide
โ โโโ ๐ GITHUB_CONTAINER_REGISTRY_GUIDE.md # GHCR Guide
โโโ ๐ง mcp-example/ # MCP Integration Examples
โโโ fastmcp_http_server.py # FastMCP HTTP Server
โโโ requirements.txt # Python Dependencies
โโโ start_fastmcp_http_server.sh # Startup Script
```
## ๐ Quick Start
### ๐ณ One-Click Docker Setup (Recommended)
Get up and running in under 2 minutes:
```bash
# 1. Clone the repository
git clone https://github.com/chuangyeshuo/mcprapi.git
cd mcprapi
# 2. Start development environment (with hot reload & admin tools)
docker-compose -f docker-compose.dev.yml up -d
# 3. Check service status
docker-compose -f docker-compose.dev.yml ps
# ๐ Your MCP RAPI system is now running!
```
**๐ Access URLs:**
- **Frontend Dashboard**: http://localhost:8082
- **Backend API**: http://localhost:8081
- **API Documentation**: http://localhost:8081/swagger/index.html
- **Health Check**: http://localhost:8081/health
- **Database Admin**: http://localhost:8083 (Adminer)
- **Redis Admin**: http://localhost:8084 (Redis Commander)
**๐ Default Login:**
```
Username: admin
Password: admin
```
> โ ๏ธ **Security Note**: Please change the default password immediately after first login!
### ๐ญ Production Deployment
#### ๐ณ GitHub Container Registry (ๆจ่)
ไฝฟ็จ้ขๆๅปบ็Docker้ๅๅฟซ้้จ็ฝฒ๏ผ
```bash
# 1. ่ฟๅ
ฅ้จ็ฝฒ็ฎๅฝ
cd deploy
# 2. ้
็ฝฎ็ฏๅขๅ้
cp .env.production .env
# ็ผ่พ .env ๆไปถ๏ผ่ฎพ็ฝฎๅฟ
่ฆ็็ฏๅขๅ้
# 3. ไฝฟ็จGHCR้ๅๅฏๅจๆๅก
docker-compose -f docker-compose.ghcr.yml up -d
# 4. ๆฃๆฅๆๅก็ถๆ
docker-compose -f docker-compose.ghcr.yml ps
```
**๐ ่ฏฆ็ปๆๅ**: ๆฅ็ [`deploy/README.md`](deploy/README.md) ่ทๅๅฎๆด็้จ็ฝฒ่ฏดๆ
#### ๐๏ธ ๆฌๅฐๆๅปบ้จ็ฝฒ
```bash
# 1. Configure environment variables
cp .env.example .env
# Edit .env file with your production settings
# 2. Start production environment
docker-compose up -d
# 3. Check service status
docker-compose ps
```
**Production URLs:**
- **Frontend**: http://localhost:8082
- **Backend API**: http://localhost:8081
- **API Documentation**: http://localhost:8081/swagger/index.html
- **Health Check**: http://localhost:8081/health
### ๐ป Local Development Setup
๐ Prerequisites
- **Go** 1.21+ ([Download](https://golang.org/dl/))
- **Node.js** 18+ ([Download](https://nodejs.org/))
- **MySQL** 8.0+ ([Download](https://dev.mysql.com/downloads/))
- **Redis** 6.0+ ([Download](https://redis.io/download))
- **Python** 3.8+ (for MCP integration)
#### ๐ง Backend Setup
```bash
# Navigate to backend directory
cd backend
# Install Go dependencies
go mod download
# Copy and edit configuration
cp configs/dev.yaml.example configs/dev.yaml
# Edit configs/dev.yaml with your database settings
# Initialize database (creates admin user)
go run scripts/init_admin.go
# Start the backend server with hot reload
go run cmd/main.go --config configs/dev.yaml
# ๐ Backend running on http://localhost:8081
```
#### ๐จ Frontend Setup
```bash
# Navigate to frontend directory
cd frontend
# Install Node.js dependencies
npm install
# Start development server with hot reload
npm run serve
# ๐จ Frontend running on http://localhost:8080
```
#### ๐ค MCP Server Setup (Optional)
```bash
# Navigate to MCP example directory
cd mcp-example
# Install Python dependencies
pip install -r requirements.txt
# Start FastMCP HTTP server
./start_fastmcp_http_server.sh
# ๐ค MCP Server running on http://localhost:8080
```
## ๐ Documentation
### ๐ API Documentation
Interactive API documentation is available once the system is running:
**๐ Swagger UI**: [http://localhost:8081/swagger/index.html](http://localhost:8081/swagger/index.html)
### ๐ Default Credentials
```
๐ค Username: admin
๐ Password: admin
```
> โ ๏ธ **Security Note**: Please change the default password immediately after first login!
### ๐ Additional Resources
- [๐ **ๆๆกฃๆป่ง**](DOCS_OVERVIEW.md) - **ๅฎๆดๆๆกฃๅฏผ่ชๅๅญฆไน ่ทฏๅพ**
- [๐ Quick Start Guide](QUICK_START.md) - **Start here for fastest setup!**
- [๐ Complete Deployment Guide](DEPLOYMENT_GUIDE.md) - **Comprehensive deployment instructions**
- [๐๏ธ System Architecture](APIๅค็งๆทๆๆ็ฎก็็ณป็ปๆถๆๆๆกฃ.md)
- [๐๏ธ Database Setup Guide](DATABASE_INIT.md)
- [๐ณ Docker Deployment Guide](DOCKER_DEPLOYMENT.md)
- [๐ข Department Management](ๆฐๅข้จ้จๆต็จๆๆกฃ.md)
- [๐ค MCP Integration Guide](mcp-example/FASTMCP_HTTP_CONFIG.md)
### ๐ง Deployment Options
| ้จ็ฝฒๆนๅผ | ้็จๅบๆฏ | ้พๅบฆ | ๆจ่ๆๆฐ | ๆๆกฃ้พๆฅ |
|---------|---------|------|---------|----------|
| [๐ณ GitHub Container Registry](deploy/README.md) | ็ไบง็ฏๅขใๅฟซ้้จ็ฝฒ | โญ | โญโญโญโญโญ | [้จ็ฝฒๆๅ](DEPLOY_QUICK_START.md) |
| [๐ณ Docker Compose](DEPLOYMENT_GUIDE.md#-docker-compose-ไธ้ฎ้จ็ฝฒๆจ่) | ็ไบง็ฏๅขใๅข้ๅไฝ | โญโญ | โญโญโญโญ | [ๅฎๆดๆๅ](DEPLOYMENT_GUIDE.md) |
| [๐ป ๆๅจ้จ็ฝฒ](DEPLOYMENT_GUIDE.md#-ๆๅจ้จ็ฝฒ) | ๅญฆไน ็ ็ฉถใๆทฑๅบฆๅฎๅถ | โญโญโญโญ | โญโญโญ | [ๆๅจ้จ็ฝฒ](DEPLOYMENT_GUIDE.md) |
| [โ๏ธ ไบๅ็้จ็ฝฒ](DEPLOYMENT_GUIDE.md#-็ๆงไธๆฅๅฟ) | ๅคง่งๆจก็ไบง็ฏๅข | โญโญโญ | โญโญโญโญ | [ไบๅ็ๆๅ](DEPLOYMENT_GUIDE.md) |
**๐ฏ ้ๆฉๅปบ่ฎฎ๏ผ**
- **ๆฐๆ็จๆท**: ๆจ่ไฝฟ็จ [GitHub Container Registry ้จ็ฝฒ](DEPLOY_QUICK_START.md) - ๆๅฟซๆ็ฎๅ
- **ๅผๅ่
**: ๆจ่ๆฅ็ [ๅฎๆด้จ็ฝฒๆๅ](DEPLOYMENT_GUIDE.md) ไบ่งฃๆๆ้้กน
- **่ฟ็ปดๅข้**: ๆจ่้
่ฏป [ๆง่ฝไผๅ](DEPLOYMENT_GUIDE.md#-ๆง่ฝไผๅ) ๅ [ๅฎๅ
จ้
็ฝฎ](DEPLOYMENT_GUIDE.md#-ๅฎๅ
จ้
็ฝฎ) ็ซ ่
**๐ ็ธๅ
ณๅทฅๅ
ท๏ผ**
- [๐ GitHub Token ๆ้ๆฃๆฅ](deploy/check-token-permissions.sh) - ้ช่ฏ้จ็ฝฒๆ้
- [๐ ๆๅปบ็ถๆๆฅ็](deploy/BUILD_STATUS.md) - ๆฅ็ๆๆฐๆๅปบไฟกๆฏ
- [๐ ๏ธ ๆ
้ๆ้คๆๅ](deploy/GITHUB_PACKAGES_TROUBLESHOOTING.md) - ่งฃๅณๅธธ่ง้ฎ้ข
## ๐ Key Capabilities
### ๐ Permission Management
- **Fine-grained Control**: API-level permission management
- **Role-based Access**: Hierarchical role system
- **Dynamic Updates**: Real-time permission changes
- **Audit Trail**: Complete permission history
### ๐ข Multi-tenant Architecture
- **Organization Isolation**: Complete data separation
- **Department Hierarchy**: Multi-level organizational structure
- **Business Line Support**: Cross-department collaboration
- **Scalable Design**: Supports thousands of users
### ๐ค MCP Integration
- **Native Support**: Built-in MCP protocol compatibility
- **AI-Ready**: Perfect for LLM and AI applications
- **Context Management**: Intelligent context handling
- **Protocol Compliance**: Full MCP specification support
## ๐ค Contributing
We welcome contributions from the community! Here's how you can help make MCP RAPI even better:
### ๐ Bug Reports
Found a bug? Please create an issue with:
- **Clear Description**: What went wrong?
- **Reproduction Steps**: How can we reproduce it?
- **Expected Behavior**: What should have happened?
- **Environment**: OS, browser, versions, etc.
### ๐ก Feature Requests
Have a great idea? We'd love to hear it! Please include:
- **Use Case**: Why is this feature needed?
- **Proposed Solution**: How should it work?
- **Examples**: Any relevant examples or mockups
### ๐ง Development Workflow
1. **Fork** the repository
2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
3. **Commit** your changes (`git commit -m 'feat: add amazing feature'`)
4. **Push** to the branch (`git push origin feature/amazing-feature`)
5. **Open** a Pull Request
### ๐ Code Standards
- **Go**: Follow [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
- **Vue.js**: Follow [Vue.js Style Guide](https://vuejs.org/style-guide/)
- **Commits**: Use [Conventional Commits](https://www.conventionalcommits.org/)
- **Testing**: Include tests for new features
- **Documentation**: Update docs for API changes
## ๐ Star History
[](https://star-history.com/#chuangyeshuo/mcprapi&Date)
## ๐ Roadmap
- [ ] **GraphQL API Support** - Alternative to REST APIs
- [ ] **Advanced Analytics** - Permission usage insights
- [ ] **SSO Integration** - SAML, OAuth2, OIDC support
- [ ] **Mobile App** - Native mobile management app
- [ ] **Kubernetes Operator** - K8s native deployment
- [ ] **Advanced MCP Features** - Enhanced protocol support
## ๐ License
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
## ๐ Acknowledgments
Special thanks to these amazing projects that make MCP RAPI possible:
- [๐ Casbin](https://casbin.org/) - Authorization library that powers our RBAC
- [๐ Gin](https://gin-gonic.com/) - High-performance HTTP web framework
- [๐จ Vue.js](https://vuejs.org/) - Progressive JavaScript framework
- [๐งฉ Element UI](https://element.eleme.io/) - Beautiful Vue.js component library
- [๐ค Model Context Protocol](https://modelcontextprotocol.io/) - AI context management standard
## ๐ฌ Community & Support
- **๐ฌ Discussions**: [GitHub Issues](https://github.com/chuangyeshuo/mcprapi/issues)
- **๐ Issues**: [GitHub Issues](https://github.com/chuangyeshuo/mcprapi/issues)
- **๐ง Email**: support@mcp-rapi.com
- **๐ฑ Discord**: [Join our Discord](https://discord.gg/DmyRA3Nj)
---
**Made with โค๏ธ by the MCP RAPI Community**
[โญ Star us on GitHub](https://github.com/chuangyeshuo/mcprapi) โข [๐ Report Bug](https://github.com/chuangyeshuo/mcprapi/issues) โข [๐ก Request Feature](https://github.com/chuangyeshuo/mcprapi/issues) โข [๐ฌ Join Discussion](https://github.com/chuangyeshuo/mcprapi/issues)
**๐ Ready to revolutionize your API permission management? Get started now!**
|
# ๐ง MCP RAPI
**Modern API Permission Management System with MCP Integration**
[](https://golang.org/)
[](https://vuejs.org/)
[](LICENSE)
[](https://docker.com/)
[](https://modelcontextprotocol.io/)
[๐ฏ Features](#-features) โข [๐ Quick Start](#-quick-start) โข [๐ Documentation](#-documentation) โข [๐ค Contributing](#-contributing) โข [๐ Star History](#-star-history)