# Sailor

**Repository Path**: ballxmx/Sailor

## Basic Information

- **Project Name**: Sailor
- **Description**: goframe,vue,admin
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 3
- **Created**: 2024-09-01
- **Last Updated**: 2025-02-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Go语言, Vue

## README

<div align=center>
<img src="img/logo.png" width="200" height="200" />
</div>
<div align=center>
<img src="https://img.shields.io/badge/golang-1.23.4-blue"/>
<img src="https://img.shields.io/badge/goframe-2.8.2-green"/>
<img src="https://img.shields.io/badge/vue-^3.4.15-blue"/>
<img src="https://img.shields.io/badge/element--plus-2.2.32-green"/>
<img src="https://img.shields.io/badge/nodejs-23.5.0-blue"/>
<img src="https://img.shields.io/badge/scui-1.6.9-green"/>
</div>

## 1. 基本介绍

### 1.1 项目介绍

> Sailor是一个基于 [vue](https://vuejs.org) 和 [goframe](https://goframe.org/)
> 和 [scui](https://gitee.com/lolicode/scui)<br>
> 开发的全栈前后端分离的开发基础平台，集成jwt鉴权，动态路由，动态菜单，casbin鉴权，按钮级权限控制等功能。

[//]: # ([在线预览]&#40;http://demo.Sailor.com&#41;: http://demo.Sailor.com)

[//]: # ()

[//]: # (测试用户名：admin)

[//]: # ()

[//]: # (测试密码：123456)

### 1.2 贡献指南

Hi! 首先感谢你使用 Sailor。

Sailor 是一套为快速研发准备的一整套前后端分离架构式的开源框架，旨在快速搭建中小型项目。

Sailor 的成长离不开大家的支持，如果你愿意为 Sailor 贡献代码或提供建议，请阅读以下内容。

#### 1.2.1 Issue 规范

- issue 仅用于提交 Bug 或 Feature 以及设计相关的内容，其它内容可能会被直接关闭。

- 在提交 issue 之前，请搜索相关内容是否已被提出。

#### 1.2.2 Pull Request 规范

- 请先 fork 一份到自己的项目下，不要直接在仓库下建分支。

- commit 信息要以`[文件名]: 描述信息` 的形式填写，例如 `README.md: fix xxx bug`。

- 如果是修复 bug，请在 PR 中给出描述信息。

- 合并代码需要两名维护人员参与：一人进行 review 后 approve，另一人再次 review，通过后即可合并。

## 2. 使用说明

```
- node版本 >= v23.5.0
- golang版本 >= v1.23.4
- IDE推荐：Goland
```

### 2.1 Sailor-console-server

使用 `Goland` 等编辑工具，打开Sailor目录

```bash

# 克隆项目
https://gitee.com/ballxmx/Sailor.git

# 进入server文件夹
cd app/Sailor-console-server/

# 使用 go mod 并安装go依赖包
go mod tidy

# 运行
go run . 
```

### 2.2 Sailor-console-web

```bash
# 进入web文件夹
cd cd app/Sailor-console-web/

# 安装依赖
pnpm install

# 启动web项目
npm run dev
```

## 3. 技术选型

- 前端：用基于 [Vue](https://vuejs.org) 的 [Element-plus](https://element-plus.org/) 构建基础页面。
- 后端：用 [goframe](https://goframe.org/) 快速搭建基础restful风格API，[goframe](https://gin-gonic.com/) 是一个go语言编写的Web框架。
- 数据库：采用`MySql` > (5.7) 版本 数据库引擎 InnoDB。
- API文档：使用`goframe-Swagger`构建自动化文档。

## 4. 主要功能

- 权限管理：基于`jwt`和`casbin`实现的权限管理。
- 用户管理：系统管理员分配用户角色和角色权限。
- 角色管理：创建权限控制的主要对象，可以给角色分配不同api权限,按钮权限和菜单权限。
- api管理：不同用户可调用的api接口的权限不同。

## 5. 项目截图

<div align=center>
<img src="img/login.png"  alt=""/>
<img src="img/home.png"  alt=""/>
</div>