https://github.com/yianandcode/tipsy

Tipsy is command line interface helps you work with the gin framework
https://github.com/yianandcode/tipsy

gin gin-gonic go golang

Last synced: 2 days ago
JSON representation

Tipsy is command line interface helps you work with the gin framework

• Host: GitHub
• URL: https://github.com/yianandcode/tipsy
• Owner: YianAndCode
• License: mit
• Created: 2025-01-12T17:59:24.000Z (14 days ago)
• Default Branch: main
• Last Pushed: 2025-01-23T20:20:47.000Z (3 days ago)
• Last Synced: 2025-01-23T20:25:14.670Z (3 days ago)
• Topics: gin, gin-gonic, go, golang
• Language: Smarty
• Homepage:
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-zh.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tipsy

`tipsy` 是一个辅助你使用 Gin 框架做开发的命令行工具

[English](README.md) | 简体中文

## 简介

Tipsy 是一个使用 Go 编写的用于 Gin 框架项目的命令行工具。类似于 Laravel 的 `artisan`，它可以初始化一个新的 Gin 项目，并快速生成各种组件，如数据库实体、存储层、控制器、中间件和服务。

## 安装

```bash

go install github.com/YianAndCode/tipsy/cmd/tipsy@latest

```

## 使用方法

### 创建新项目

创建一个新的 Gin 项目：

```bash

tipsy create 

```

这个命令将生成一个结构完善的 Gin 项目，目录结构如下：

```

.

├── cmd

│   └── api

│       └── bootstrap

└── internal

    ├── config

    ├── contract

    │   ├── constant

    │   │   └── errcode

    │   ├── datatype

    │   └── error

    ├── controller

    │   └── user

    ├── data

    ├── entity

    ├── log

    ├── middleware

    │   └── auth

    ├── repo

    │   └── user

    ├── router

    ├── server

    └── service

        └── user

```

### 生成组件

Tipsy 提供了多个命令来生成不同的组件：

1. 创建新实体：

```bash

tipsy new entity 

```

2. 创建新仓储层：

```bash

tipsy new repo 

```

3. 创建新控制器：

```bash

tipsy new controller 

```

4. 创建新中间件：

```bash

tipsy new middleware 

```

5. 创建新服务：

```bash

tipsy new service 

```

每个命令都会生成相应的 Go 源文件。

## 开源许可

本项目采用 MIT 开源许可 - 查看 [LICENSE](LICENSE) 文件了解详情。