logo
3
0
Login
编辑文件 README.md

XiRang

Auth Go Version Gin Version Gorm Version GitHub Issues GitHub Pull Requests GitHub Pull Requests HitCount GitHub license

🐉 简单好用,不缠不绕,直接上手的go-web框架


Project logo

xirang,亦即息壤,大概在我读小学时,父亲从外地回来,并带回来几本读物,其中一本是迅哥儿小时候最爱读的《山海经》,也是在那时,我第一次认识这个词语。

维基百科对其解释是:息壤是中国古代传说中的一种神物,所谓“息壤”就是自己可以自动生长的土壤。用“息壤”修筑的堤坝,洪水长一米,堤坝也自动长一米。

我将项目命名为xirang,亦是希望在自己不间断地学习积累之中,项目也能够越发成长,并有其丰富的力量。

🥸 项目介绍

xirang 是一个非常简单的 gin+gorm 框架的基础架构,你只需要修改简单的代码,即可开始上手编写你的接口。

只需要根据情况修改配置config.yml,然后配置里边的数据库配置信息,即可开始开发。

数据库支持 MySQL 与 sqlite3(无 CGO 依赖),如果你的系统仅为运维内部一个小系统,则推荐你使用 sqlite3。数据表会自动映射并创建。

快速开发

这是一个前后端放在一起的项目,部署的时候,也是将前端dist嵌入到后端二进制。

日常开发,可通过如下命令,快速启动。

首先建议直接使用CNB远程开发打开项目,已内置go和node环境,可直接投入开发使用。

go版本为 1.24, node版本为18

打开之后,可以先进入到 ui 目录,用code命令,新启动一个窗口。

启动后端:

# 启动后端,在根目录,直接执行如下命令 air

启动前端:

# 在ui打开的窗口中,执行如下命令 $ pnpm i $ pnpm dev

后端监听在8888端口,前端监听在8848端口,分别在vscode中映射出来,然后在本地方位8848,就可以看到前端登陆页面,默认已填充了用户名密码,直接点击登陆即可进入后台首页。