Skip to content

solefaucet/jackpot-server

Repository files navigation

jackpot-server

Build Status Go Report Card codecov.io

======

Requirement

  • go1.6
  • mysql5.7

Installation

# easy enough by go get
$ go get -u github.com/solefaucet/jackpot-server

DB Migration

Requirement

goose is needed for DB migration

$ go get bitbucket.org/liamstask/goose/cmd/goose

How to

# Migrate DB to the most recent version available
$ goose up

# Roll back version by 1
$ goose down

# Create a new migration
$ goose create SomeThingDescriptiveEnoughForYourChangeToDB sql

Development

Dependency Management

# After third party library is introduced or removed
$ godep save ./...

Lint

$ make metalint

Test

$ make test

CONTRIBUTE

  • fork it
  • create an issue that describes what you are going to work on
  • create a new branch in your own repo and do the job
  • use commitizen to write commit message so we can generate change log in the future with conventional-changelog
  • create a pull request that connects to the issue

how to write commit message

# install commitzen and cz-conventional-changelog first
$ npm install -g commitizen --verbose
$ npm install

# use git cz instead of git commit in the future
# follow the instructions to write commit message
$ git add files && git cz

License

jackpot-server is released under version 3.0 of the GNU General Public License.