# irisfarm

**Repository Path**: ken.yang/irisfarm

## Basic Information

- **Project Name**: irisfarm
- **Description**: 基于iris web框架，对各种使用做了封装，可以直接开箱即用
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/ken.yang/irisfarm
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 4
- **Created**: 2019-10-12
- **Last Updated**: 2025-12-08

## Categories & Tags

**Categories**: webframework

**Tags**: None

## README

## iris farm

基于iris web框架，对各种使用做了封装，可以直接开箱即用

### 命名由来

为啥起名叫irisfarm，此项目是把iris和其他一些东西组合起来，形成日常使用的web框架，可以基于这套规范进行快速开发，所以起名叫iris farm，具有iris农场的意思

### 如何使用

```
执行
go run main.go

访问
127.0.0.1:8080
```

### 功能

- route
- validate
- controller
- server
- repository
- model
- config(viper)
- log(logrus)
- database(gorm)
- redis
- mongodb
- json output
- auth jwt登录认证

### 目录结构

```
app 
    commons 一些公共功能
    controllers 控制器
    core 核心代码
        config 配置
        db 数据库 mysql、mongo、redis...
        log 日志
        output 输出
        validate 验证
    helper 常量与帮助类
    middlewares 中间件
    models 模型
    repositories 仓库
    services 业务
    validates 验证
configs 配置
routes 路由
    api api路由
    test test路由
storage 存储日志等
    logs 日志
    ssl ssl文件
tests 测试
vendor 引用包
main.go 入口
go.mod go module
```

基本的配置都在main.go里面做了相应的处理，添加功能和移除功能都可以在main.go里面进行追加和注释代码

### 配置

直接在configs下面增加yml文件，然后再main.go里面添加一个配置文件即可

```
config.New("app", "cors", "database", "iris", "ssl")
```

## 贡献代码

欢迎大家fork和提pull requests。

## 意见&建议

如果你有任何的想法或是建议那就给我留个言吧!