Distributed and Decentralised Systems Course Project

Build and Run:

1 Configure database link (mysql) /config/config.yaml:

2 Setup Environment Variables

DDS_TELEGRAM_BOT_APIKEY - api key for telegram bot

GO111MODULE=auto - enable go modules

3 Get dependencies

go get -u github.com/go-sql-driver/mysql
go get -u github.com/jinzhu/gorm
go get -u github.com/gin-gonic/gin
go get -u github.com/gin-contrib/cors
go get -u github.com/gin-contrib/static
go get -u github.com/go-telegram-bot-api/telegram-bot-api
go get -u github.com/robfig/cron

4 Get server

INSIDE $GOPATH/src

git clone https://github.com/dds-project-f19/dds-backend

5 Build

go install $GOPATH/src/dds-backend

6 Run

Now you can launch with executable located at $GOPATH/bin/ called dds-backend (.exe for Windows)

$ dds-backend --help
Usage of dds-backend:
  -dbaddress string
         (default "127.0.0.1")
  -dblogin string
         (default "root")
  -dbname string
         (default "ddstest")
  -dbpassword string
         (default "ddspassword14882")
  -dbport string
         (default "3306")

API Description (to be moved to wiki later):

// POST /common/login
// HEADERS: {}
// {"username":"123", "password":"456"}
// 200: {"token":"1234567", "claim":"worker|manager|admin", "gametype":"surgeon1"}
// 400,403: {"message":"123"}

// GET /common/telegram_join_link
// HEADERS: {Authorization: token}
// {}
// 200: {"link":"t.me/bot_link/start=regkey123"}
// 401, 500: {"message":"123"}

// POST /common/logout
// HEADERS: {Authorization: token}
// {}
// 200: {}
// 401,500: {}

// GET /worker/get
// HEADERS: {Authorization: token}
// {}
// 200: {"username":"required", "name":"", "surname":"", "phone":"", "address":""}
// 401,404: {"message":"123"}

// PATCH /worker/update
// HEADERS: {Authorization: token}
// {"username":"required", "name":"", "surname":"", "phone":"", "address":""}
// 200: {}
// 400,401,404: {"message":"123"}

// POST /worker/take_item
// HEADERS: {Authorization: token}
// {"itemtype":"123", "slot":"123"}
// 201: {"message":"request done, blah blah"}
// 400,401,500: {"message":"123"}

// POST /worker/return_item
// HEADERS: {Authorization: token}
// {"slot":"123"}
// 201: {"message":"request done, blah blah"}
// 400,401,500: {"message":"123"}

// GET /worker/list_available_items
// HEADERS: {Authorization: token}
// {}
// 200: {"items":[{"itemtype":"123","count":77}]}
// 401,500: {"message":"123"}

// GET /worker/list_taken_items
// HEADERS: {Authorization: token}
// {}
// 200: {"items":[{"takenby":"username","itemtype":"123","assignedtoslot":"123"}]}
// 401,500: {"message":"123"}

// POST /manager/register_worker
// {"username":"required", "password":"required", "name":"", "surname":"", "phone":"", "address":""}
// 201: {}
// 400,409,500: {"message":"123"}

// GET /manager/list_workers
// HEADERS: {Authorization: token}
// {}
// 200: {"users":[{"username":""...}]}
// 401,500: {"message":"123"}

// DELETE /manager/remove_worker/{username}
// HEADERS: {Authorization: token}
// {}
// 200: {}
// 400,401,404,500: {"message":"123"}

// PATCH /manager/set_available_items
// HEADERS: {Authorization: token}
// {"itemtype":"123","count":77}
// 200: {}
// 400,401,500: {"message":"123"}

// GET /manager/list_available_items
// HEADERS: {Authorization: token}
// {}
// 200: {"items":[{"itemtype":"123","count":77}]}
// 401,500: {"message":"123"}

// GET /manager/list_taken_items
// HEADERS: {Authorization: token}
// {}
// 200: {"items":[{"takenby":"username","itemtype":"123","assignedtoslot":"123"}]}
// 401,500: {"message":"123"}

// POST /admin/register_manager
// HEADERS: {}
// {"username":"required", "password":"required", "gametype":"required", "name":"", "surname":"", "phone":"", "address":""}
// 201: {}
// 400,401,409,500: {"message":"123"}

// GET /manager/get_worker_schedule/{username}
// HEADERS: {Authorization: token}
// {}
// 200: {"starttime":"12:13", "endtime":"14:13", "workdays";"1,4,5"}
//

// POST /manager/set_worker_schedule
// HEADERS: {Authorization: token}
// {"username":"abc", "starttime":"12:13", "endtime":"14:13", "workdays";"1,4,5"} - workdays are monday, thursday, friday
// 200: {}
// 400, 401, 404, 500: {"message":"123"}

// GET /worker/get_schedule
// HEADERS: {Authorization: token}
// {}
// 200: {"starttime":"12:13", "endtime":"14:13", "workdays";"1,4,5"}
// 401, 404: {"message":"123"}

// POST /manager/check_overlap
// HEADERS: {Authorization: token}
// {"username":"worker1", "starttime":"10:20", "endtime":"10:30", "workdays":"1,2,3"}
// 200: {"overlap":true} - true (not string) for overlap error, false for no overlap
// 401, 404, 500: {"message":"123"}

// GET /worker/check_currently_available
// HEADERS: {Authorization: token}
// {}
// 200: {"available":false}
// 401, 500: {"message":"123"}