Skip to content

Commit

Permalink
update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
hyperjiang committed Apr 24, 2018
1 parent 1a0fca6 commit 6fdf996
Show file tree
Hide file tree
Showing 4 changed files with 215 additions and 3 deletions.
150 changes: 150 additions & 0 deletions Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

58 changes: 58 additions & 0 deletions Gopkg.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Gopkg.toml example
#
# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
# for detailed Gopkg.toml documentation.
#
# required = ["github.com/user/thing/cmd/thing"]
# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
#
# [[constraint]]
# name = "github.com/user/project"
# version = "1.0.0"
#
# [[constraint]]
# name = "github.com/user/project2"
# branch = "dev"
# source = "github.com/myfork/project2"
#
# [[override]]
# name = "github.com/x/y"
# version = "2.4.0"
#
# [prune]
# non-go = false
# go-tests = true
# unused-packages = true


[[constraint]]
branch = "master"
name = "github.com/appleboy/gin-jwt"

[[constraint]]
branch = "master"
name = "github.com/gin-gonic/gin"

[[constraint]]
branch = "master"
name = "github.com/golang/glog"

[[constraint]]
name = "github.com/jinzhu/gorm"
version = "1.9.1"

[[constraint]]
name = "github.com/stretchr/testify"
version = "1.2.1"

[[constraint]]
branch = "master"
name = "golang.org/x/crypto"

[[constraint]]
name = "gopkg.in/yaml.v2"
version = "2.2.1"

[prune]
go-tests = true
unused-packages = true
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ Gin Skeleton is a simple boilerplate to kickstart a web server project based on
go run main.go
```

## Installation

Run `dep ensure`

## Components

- Framework: [gin-gonic/gin](https://github.com/gin-gonic/gin)
- Dependency management: [golang/dep](golang/dep)
- Dependency management: [golang/dep](https://github.com/golang/dep)
- Database ORM: [jinzhu/gorm](https://github.com/jinzhu/gorm)
- Database migration: [rubenv/sql-migrate](https://github.com/rubenv/sql-migrate)
- Leveled logs: [golang/glog](https://github.com/golang/glog)
Expand Down Expand Up @@ -55,4 +59,4 @@ CREATE DATABASE IF NOT EXISTS `gin` DEFAULT CHARACTER SET utf8mb4;

```
./migrate.sh new a_new_migration
```
```
2 changes: 1 addition & 1 deletion config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ database:
dir: sql
table: migrations
max_idle_conns: 2
max_open_conns: 16
max_open_conns: 16

0 comments on commit 6fdf996

Please sign in to comment.