Skip to content
/ grain Public

Grain 是一个前后端分离的开发基础平台,集成了 JWT,Casbin,动态菜单,用户管理,CRUD代码生成等基础功能

License

Notifications You must be signed in to change notification settings

go-zxb/grain

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grain是什么:

Grain是一个基于Gin + Gorm&Gen + Vue + ArcoDesign开发的前后端分离的可开箱即用的中后台管理基础脚手架

Grain能做什么:

  • Grain致力于提供最简单的开箱即用的脚手架基础平台,帮助用户快速搭建中后台管理系统
  • Grain使用 JWT 进行身份验证。使用 Casbin 实现基于角色的访问控制,控制资源权限。前端菜单可根据权限动态获取显示对应的菜单。
  • Grain能够根据输入的模型字段自动生成前端 CRUD 管理页面和后端 API 接口

Grain基础通用功能:

  • 代码助手:
  • 用户管理:
  • 组织管理:
  • API管理:
  • 菜单管理:
  • 角色管理:
  • 附件管理:

开发环境(必要依赖)

  • Node v20.1.0
  • Golang v1.20.14
  • Redis v5.0.10
  • MySql v8.0.29
  • MongoDB v4.0.10

使用介绍

后端:
  1. 从github clone项目到本地

     git clone https://github.com/go-grain/grain.git
  2. 运行build文件生成repo的一些依赖(比较懒,不想提交到git)

    #cd 进入项目根目录
    cd grain/grain-server
    #运行build文件
    go run ./cmd/gen/build.go
  3. 运行项目

    #拉取依赖
    go mod tidy 
    #运行项目
    go run ./cmd/main.go 
前端
  1. 进入到前端根目录
    #假设你现在在grain-server目录下,cd后退接入前端目录
    cd ../grain-arco-web
    #拉取依赖
    yarn install
    or
    npm install
    #运行
    yarn run dev
    or
    npm run dev

2.开发教程

工程目录结构
├─base          #放一些基础的东西
├─cmd           #程序入口
│  └─gen        #存放Gorm Gen build文件
├─config        #配置文件
├─core          #程序核心启动层
├─docs          #swagger文档
├─log           #日志记录层
├─middleware    #中间件
├─model         #数据模型层
├─repo          #repo层
├─internal      #存放不希望外部调用的东西
│  ├─handler    #api层
│  ├─repo       #repo层
│  ├─router     #路由层
│  └─service    #业务逻辑处理层
├─stencil       #模版
└─utils         #工具包

作者微信

特别的非感谢

  • ArcoDesignPro(感谢提供了开箱即用的ArcoPro)
  • casbin(感谢提供资源对象鉴权能力)
  • gin(感谢提供出色的Web和API开发框架)
  • go-redis(感谢提供进行Redis数据库交互能力)
  • viper(感谢提供友好的配置解决方案)
  • gin-swagger(感谢提供在gin框架中生成Swagger文档的库)
  • gorm&Gen(感谢提供ORM和Gen代码生成能力)
  • gva(非常感谢三水哥的gva项目,它为我提供了许多有价值的借鉴和思路(^狗头^))

About

Grain 是一个前后端分离的开发基础平台,集成了 JWT,Casbin,动态菜单,用户管理,CRUD代码生成等基础功能

Resources

License

Stars

Watchers

Forks

Packages

No packages published