# ky-admin

**Repository Path**: lkyuan4/ky-admin

## Basic Information

- **Project Name**: ky-admin
- **Description**: 多租户架构的通用管理后台
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-31
- **Last Updated**: 2025-01-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 通用管理后台（ky-admin）

通用管理后台，使用Vue+Django实现多租户架构。通过共享和复用资源降低成本，提高效率和可扩展性。实现多租户架构需关注数据隔离、身份认证和授权、资源管理、定制和扩展等方面，并应对数据一致性、性能和扩展、租户隔离和安全性等挑战。采取最佳实践可实现高效、灵活和安全的多租户架构。

# 关键词
SAAS、JWT、敏感数据加密存储、接口签名

# 基本功能

* 租户管理
* 用户管理
* 菜单管理
* 权限管理
* 单位管理
* 角色管理
* 通知管理
* 日志管理
* 定时任务

# 系统优势
* 成本效益：通过多租户架构，可以将硬件、软件等资源进行共享和复用，从而降低了部署和运维的成本。
* 可扩展性：多租户架构可以通过水平扩展来满足用户规模的增长。通过添加更多的服务器和实例，可以轻松地处理更多的租户和并发请求。
* 安全性：多租户架构确保不同租户之间的数据和配置被隔离开来，保证了数据的安全性和隐私性。即使一个租户发生安全问题，也不会影响其他租户的数据和服务。
* 快速部署：基于多租户架构的SaaS应用可以通过自动化和模板化的方式进行快速部署和配置，减少了部署和上线的时间和工作量。

# Getting started

## 安装模块
```bash
pip3 install django
pip3 install djangorestframework
pip3 install djangorestframework-simplejwt
pip3 install django-filter
pip3 install django-environ
pip3 install django-redis
pip3 install pymysql
pip3 install uwsgi
pip3 install pycryptodome
pip3 install coreapi
pip3 install setuptools 
pip3 install loguru
pip3 install gmssl
pip3 isntall apscheduler
pip3 install channels channels_redis daphne
pip3 install paho-mqtt
```

## 创建数据库，并导入数据
+ 目前只支持mysql数据库，安装后导入数据
```bash
create database ky-admin;
use ky-admin;
source ~/db/migrate-default.sql
```

## 修改数据库相关配置
```bash
admin/.env
admin/.env.dev
# 数据库配置
DB_ENGINE=django.db.backends.mysql
DB_NAME=ky-admin
DB_HOST=127.0.0.1
DB_USER=root
DB_PASSWORD=root
DB_PORT=3306
```

## 运行
```bash
# 运行后端
cd admin
python3 manage.py runserver

# 指定.evn环境运行
APP_ENV=dev python3 manage.py runserver


# 运行前端
cd frontend
yarn install
yarn dev

# 默认账号密码
13580544945/123456

```

# 开发相关
```bash
# 新建model表后需要执行
python3 manage.py makemigrations
python3 manage.py migrate

# 新加app模块
django-admin startapp app_name

```

# 截图
![输入图片说明](frontend/src/assets/images/preview.jpg)


# DOCKER 
docker 安装参考 https://kunyuan.tech/archives/1287
```
# 下载docker目录，进入目录后直接执行
docker-compose up -d

```

# 示例
http://ky.room58.cn/login


# MQTT
```python
python3 ~/docker/mqtt/mqtt-send.py
python3 ~/docker/mqtt/mqtt-get.py
```