# gf-start-kit

**Repository Path**: unsafe-rust/gf-start-kit

## Basic Information

- **Project Name**: gf-start-kit
- **Description**: 一个基于gf框架开发的用于快速开发项目的基础骨架,包含独立路由,插件机制等
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2021-01-26
- **Last Updated**: 2021-03-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gf-start-kit

#### 介绍
一个基于gf框架开发的用于快速开发项目的基础骨架,包含独立路由,插件机制等

#### 目录结构
```
├─app               业务代码
│  ├─controller     业务控制器
│  ├─middleware     全局中间件
│  └─service        业务逻辑服务层
├─boot              启动层,设置全局启动和加载插件
├─config            配置
├─deploy            文档和数据库
├─library           扩展目录
├─plugins           插件目录
│  ├─job            任务管理插件
│  └─tool           工具包插件借鉴oktools的代码演示加载插件静态目录和模板文件
├─public            全局静态目录
├─router            路由文件
```

#### 安装教程

1.  `git clone https://gitee.com/AbelZou/gf-start-kit.git`
2.  `cd gf-start-kit && go run main.go`
3. `导入sql deploy/gf-start-kit.sql`
#### 使用说明

1.  `app下有controller->service->model的例子和在控制器注册路由的方式`
2. 插件机制
```
plugins目录下是插件模块,可以把一些单独的功能改为插件加载到项目中,
在boot中加载
import _ "gf-start-kit/plugins/对应的插件目录名"
如:_ "gf-start-kit/plugins/job"
```
3. 支持模块化设置路由,单独给一批路由设置接口前缀
4. nsq使用[https://nsq.io/](https://nsq.io/)
```
下载nsq-window
1.nsqlookupd
2.nsqd --lookupd-tcp-address=127.0.0.1:4160
3.nsqadmin --lookupd-http-address=127.0.0.1:4161
访问nsqadmin地址http://127.0.0.1:4171
也可以直接双击deploy/nsq-start.bat使用以上三个命令
```
#### 本项目借鉴了一些项目的功能并且改善,感谢以下项目

1. gf框架 [https://gitee.com/johng/gf](https://gitee.com/johng/gf)
1. gfast [https://gitee.com/tiger1103/gfast](https://gitee.com/tiger1103/gfast)
1. 云捷go [https://gitee.com/yunjieg/yjgo](https://gitee.com/yunjieg/yjgo)