fm453/kinit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
kinit/README.md
ktianc e5c4358905 更新1.1.0
2022-11-16 15:41:24 +08:00

12 KiB
Raw Blame History

logo

[关于]

Kinit 是一套开箱即用的中后台解决方案，可以作为新项目的启动模版。

前后端分离架构，开箱即用，紧随前沿技术

因为热爱，所以拥抱未来！

介绍

Kinit 是一套全部开源的快速开发平台，毫无保留给个人及企业免费使用。

  • 🧑‍🤝‍🧑前端采用 vue-element-plus-admin 、Vue3、Element Plus、TypeScript，等主流技术开发。
  • 👭后端采用 Python 语言以及现代、快速（高性能） FastAPI 框架。
  • 👫权限认证使用（哈希）密码和 JWT Bearer 令牌的 OAuth2，支持多终端认证系统。
  • 👬支持加载动态权限菜单，多方式轻松权限控制。
  • 开箱即用的中后台解决方案，可以用来作为新项目的启动模版，也可用于学习参考。并且时刻关注着最新技术动向，尽可能的第一时间更新。

💏特别鸣谢

ELADMIN：项目基于 Spring Boot 2.1.0 、 Jpa、 Spring Security、redis、Vue的前后端分离的后台管理系统。

django-vue-admin：基于RBAC模型的权限控制的一整套基础开发平台，前后端分离，后端采用 django+django-rest-framework，前端采用 vue+ElementUI。

vue-element-plus-admin：一套基于vue3、element-plus、typescript4、vite3的后台集成方案

Ant Design Pro：开箱即用的中台前端/设计解决方案

Gin-Vue-Admin：基于vite+vue3+gin搭建的开发基础平台（支持TS,JS混用），集成jwt鉴权，权限管理，动态路由，显隐可控组件，分页封装，多点登录拦截，资源权限，上传下载，代码生成器，表单生成器等开发必备功能。

Vben Admin (vvbin.cn)：Vue Vben Admin 是一个免费开源的中后台模版。使用了最新的vue3,vite2,TypeScript等主流技术开发，开箱即用的中后台前端解决方案，也可用于学习参考。

中华人民共和国行政区划 (github.com)：省级（省份）、 地级（城市）、 县级（区县）、 乡级（乡镇街道）、 村级（村委会居委会） ，中国省市区镇村二级三级四级五级联动地址数据。

Vue Admin Plus：vue-admin-better是github开源admin中最优秀的集成框架之一，它是国内首个基于vue3.0的开源admin项目，同时支持电脑，手机，平板，默认分支使用vue3.x+antdv开发，master分支使用的是vue2.x+element开发。

小诺开源技术 (xiaonuo.vip)：国内首个国密前后端分离快速开发平台

my-web:：MyWeb 是一个企业级中后台前端/设计解决方案的的项目工程模板，它可以帮助你快速搭建企业级中后台产品原型

在线体验

👩‍👧‍👦演示地址：http://kinit.ktianc.top/

  • 账号：15020221010
  • 密码：kinit2022

源码地址

gitee地址(主推)：https://gitee.com/ktianc/kinit 👩‍👦‍👦

github地址：https://github.com/vvandk/kinit 👩‍👦‍👦

内置功能

  • 👨‍⚕️菜单管理：配置系统菜单，操作权限，按钮权限标识、后端接口权限等。

  • 👩‍⚕️角色管理：角色菜单权限分配。

  • 👨‍🎓用户管理：用户是系统操作者，该功能主要完成系统用户配置。

  • 🏡个人主页：配置用户个人信息，密码修改等。

  • 📚字典管理：对系统中经常使用的一些较为固定的数据进行维护。

  • 📁附件管理：对平台上所有文件、图片等进行统一管理，对接阿里云OSS。

  • 🔒登录认证：目前支持用户使用手机号+密码方式登录。

    说明：新建用户密码默认为手机号后六位；

    说明：用户在第一次登录时，必须修改当前用户密码。

  • 系统配置：对本系统环境信息进行动态配置

    网站标题，LOGO，描述，ICO，备案号，底部内容，百度统计代码，等等

  • 数据分析：根据用户的登录用户地址分析出哪个地区的人最多

  • 🗓️登录日志：用户登录日志记录和查询。

  • 🗓️操作日志：系统用户每次操作功能时的详细记录。

  • 🗓️异常日志：获取并展示接口异常日志

  • 🧾接口文档：提供自动生成的交互式 API 文档，与 ReDoc 文档

  • 导入导出：灵活支持数据导入导出功能

  • 手机验证码登录功能’

TODO

  • 考虑支持多机部署方案，如果接口使用多机，那么用户是否支持统一认证
  • 自动化编排服务：使用docker-compose部署项目
  • 数据库备份：自动备份数据库
  • 接入数据大屏
  • 可视化低代码表单：接入低代码表单，https://vform666.com/vform3.html?from=element_plus

前序准备

依赖包

前端

后端

安装和使用

获取代码

git clone https://gitee.com/ktianc/kinit.git

准备工作

Python >= 3.8.0 (推荐3.8+版本)
nodejs >= 14.0 (推荐最新)
Mysql >= 8.0

后端

  1. 安装依赖
cd kinit-api

pip3 install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/

  1. 修改数据库信息

    在 application/settings.py 文件中配置数据库信息，用于项目连接

    • mysql数据库版本建议：8.0
    • mysql数据库字符集：utf8mb4
    """
数据库配置项
连接引擎官方文档：https://www.osgeo.cn/sqlalchemy/core/engines.html
数据库链接配置说明：mysql+asyncmy://数据库用户名:数据库密码@数据库地址:数据库端口/数据库名称
"""
if DEBUG:
    # 测试库
    SQLALCHEMY_DATABASE_URL = "mysql+asyncmy://root:123456@127.0.0.1:3306/kinit"
    SQLALCHEMY_DATABASE_TYPE = "mysql"
else:
    # 正式库
    SQLALCHEMY_DATABASE_URL = "mysql+asyncmy://root:123456@127.0.0.1:3306/kinit"
    SQLALCHEMY_DATABASE_TYPE = "mysql"

    并在alembic.ini文件中配置数据库信息，用于数据库映射

    # mysql+pymysql://数据库用户名:数据库密码@数据库地址:数据库端口/数据库名称
sqlalchemy.url = mysql+pymysql://root:123456@127.0.0.1/kinit

  2. 创建数据库

mysql> create database kinit;             # 创建数据库
mysql> use kinit;                         # 使用已创建的数据库 
mysql> set names utf8;                    # 设置编码
  1. 映射数据库
# 初次生成映射文件
alembic revision -m "生成映射文件"

# 通过该命令可以将模型映射到数据库
alembic upgrade head

# 如果有更新，则可以使用这个命令再次生成映射文件，初次也可以使用
alembic revision --autogenerate -m "update"
# --autogenerate：自动将当前模型的修改，生成映射脚本。

# 通过该命令可以将模型映射到数据库
alembic upgrade head
  1. 导入数据库数据

导入数据库数据前，请先保存映射后数据库中alembic_version表中的version_num数据

导入完成后，将此数据替换到导入后的对应字段

# 数据库文件地址：kinit-api/static/kinit.sql
# 导入命令
mysql> source kinit-api/static/kinit.sql  # 导入备份数据库
  1. 启动
python3 main.py

前端

  1. 安装依赖
cd kinit-admin

pnpm install
  1. 运行
pnpm run dev
  1. 打包
pnpm run build:pro

访问项目

如何贡献

你可以提一个 issue 或者提交一个 Pull Request。

Pull Request:

  1. Fork 代码
  2. 创建自己的分支: git checkout -b feat/xxxx
  3. 提交你的修改: git commit -am 'feat(function): add xxxxx'
  4. 推送您的分支: git push origin feat/xxxx
  5. 提交 pull request

Git 贡献提交规范

  • feat 新功能
  • fix 修补 bug
  • docs 文档
  • style 格式、样式(不影响代码运行的变动)
  • refactor 重构(即不是新增功能，也不是修改 BUG 的代码)
  • perf 优化相关，比如提升性能、体验
  • test 添加测试
  • build 编译相关的修改，对项目构建或者依赖的改动
  • ci 持续集成修改
  • chore 构建过程或辅助工具的变动
  • revert 回滚到上一个版本
  • workflow 工作流改进
  • mod 不确定分类的修改
  • wip 开发中
  • types 类型

浏览器支持

本地开发推荐使用 Chrome 80+ 浏览器

支持现代浏览器, 不支持 IE

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

许可证

MIT

演示图

image-20221010214526082

image-20221010214526082

image-20221010214526082

image-20221010214526082

image-20221010214526082