Lite version of zaiqiuchang api server, which developed by go and deploy using docker. It also can be used as a starter kit for developing api server.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd
controllers
middlewares
models
services
test
util
Dockerfile
README.md
common.sh
config.json
deploy-prod.sh
deploy-test.sh
deploy.sh
docker-build.sh
docker-compose.override.yml
docker-compose.prod.yml
docker-compose.test.yml
docker-compose.yml
fswatch.sh
main.go
restart.sh
supervisord.conf
test.sh

README.md

Zaiqiuchang server demo

Zaiqiuchang(在球场) is a mobile app developed using React Native, both iOS and Android are supported. This project is the lite version of the api server, which developed in Go, and deploy using Docker. The lite version only include account related apis, but it should be a good start to develop your own.

Packages

Package Description
github.com/labstack/echo Http server and framework.
github.com/spf13/cobra CLI app framework.
github.com/spf13/viper Manage app configuration.
github.com/asaskevich/govalidator Validate input.
github.com/Sirupsen/logrus Logging.
gopkg.in/mgo.v2 Mongodb driver.
github.com/garyburd/redigo/redis Redis driver.
github.com/gorilla/sessions Manage user session.
github.com/smartystreets/goconvey/convey Test framework.

How to deploy

You need install docker engine first.

run in dev mode with auto detecting code change

> git clone git@github.com:jaggerwang/zqc-server-demo.git && cd zqc-server-demo
> mkdir -p ~/data/projects/zqc-server-demo # create directory for data volumes
> ./deploy.sh # pull images and run containers
> ./fswatch.sh # watching code change, fswatch needed

The data and log of server, mongodb and redis will be saved at host's path "~/data/projects/zqc-server-demo", which mounted at container's path "/data".

run in prod mode

> git clone git@github.com:jaggerwang/zqc-server-demo.git && cd zqc-server-demo
> mkdir -p /data/zqc-server-demo # create directory for data volumes
> ./deploy-prod.sh

The data and log of server, mongodb and redis will be saved at host's path "/data/zqc-server-demo", which mounted at container's path "/data".

run test

> cd zqc-server-demo
> ./test.sh
...
2017/02/11 16:01:03 parser.go:24: [passed]: zqc/test
2017/02/11 16:01:03 executor.go:69: Executor status: 'idle'

Script tesh.sh will run a new group of docker containers to run unittests, including server, mongodb and redis. The new group has separated volumes and ports, to avoid empty the existing data. We use goconvey to write and run unittests. It supplied a web console to show the test result, and will run test automatically when detected code change.

Open url "http://localhost:10402/" to view test result.

build image of your own

> cd zqc-server-demo
> ./docker-build.sh

Command

help

> cd zqc-server-demo
> docker-compose -p zqc-server-demo exec server zqc
Zai qiu chang app.

Usage:
  zqc [command]

Available Commands:
  db          Database admin
  server      Run server

Flags:
  -c, --config string              config file (default "./config.json")
      --dir.data string            directory for saving runtime data
      --env string                 deployment environment
      --log.level string           log filter level
      --mongodb.zqc.addrs string   address of zqc db

Use "zqc [command] --help" for more information about a command.

create mongodb index

> cd zqc-server-demo
> docker-compose -p zqc-server-demo exec server zqc db createIndexes

When deploy, it will auto run this command to create mongodb index. So normally you do not need to do this by your own.

API

The server container exposed port 1323, and it mapped to port 10400 of the host. So you can use domain "http://localhost:10400" to access the following api.

Path Method Description
/register POST Register account.
/login GET Login.
/isLogined GET Check whether logined.
/logout GET Logout.
/account/edit POST Edit account profile.
/account/info GET Get current account info.
/user/info GET Get user info by id.
/user/infos GET Get user info by ids.

FAQ

How to change image repository?

Search and replace all "daocloud.io/jaggerwang/zqc-server-demo" to your own.

How can I build the base images of this project, including go, mongodb and redis?

The dockerfiles of the base images can be found at "https://github.com/jaggerwang/jw-dockerfiles".

Other resources