Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/takama/back-friend
Back a friend service: used backer package/library https://github.com/takama/backer
https://github.com/takama/back-friend
bingo game game-service poker
Last synced: 18 days ago
JSON representation
Back a friend service: used backer package/library https://github.com/takama/backer
- Host: GitHub
- URL: https://github.com/takama/back-friend
- Owner: takama
- License: mit
- Created: 2018-04-09T11:46:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-04-18T20:31:27.000Z (over 6 years ago)
- Last Synced: 2024-10-15T07:51:01.623Z (2 months ago)
- Topics: bingo, game, game-service, poker
- Language: Go
- Homepage:
- Size: 119 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Back a friend
[](https://travis-ci.org/takama/back-friend)
[](https://github.com/takama/back-friend/issues)
[](https://goreportcard.com/report/github.com/takama/back-friend)
[](https://codecov.io/gh/takama/back-friend)
Back a friend service: used [backer](https://github.com/takama/backer) package/library
## Installation
Build and run
```sh
make run
```
Or pull from docker registry and run
```sh
docker-compose up -d
```
## Known restrictions
1. A several verifications of input attributes skipped due to complicating the task
2. The project is used simplest `JSON` response without additional parameters like request attributes, totals and durations
3. The players and the tournaments could not be deleted
4. The points/money are not in separate transactional entity. This feature is skipped due to complicating the task.
5. The database handlers are not asynchronous. It should be in high load systems.
6. The package `context` is skipped due to complicating the task.
## Endpoints description
### Players endpoints
Funds (add to balance) player with 300 points. If no player exist should create new player with given
amount of points
```json
PUT /api/v1alpha/players/:id/fund
{
"points": 300
}
```
Takes 300 points from player account
```json
PUT /api/v1alpha/players/:id/take
{
"points": 300
}
```
Player balance
```json
GET /api/v1alpha/players/:id
{
"player": "p1",
"balance": 456.00
}
```
### Tournaments endpoints
Announce tournament specifying the entry deposit
```json
POST /api/v1alpha/tournaments/:id/announce
{
"deposit": 1000
}
```
Join player into a tournament and is he backed by a set of backers
```json
PUT /api/v1alpha/tournaments/:id/join
{
"player": "p1",
"backers": ["p2", "p3"]
}
```
Result tournament winners and prizes
```json
POST /api/v1alpha/tournaments/:id
{
"winners": [
{
"player": "p1",
"prize": 2000.00
}
]
}
```
Get results of tournament winners and prizes
```json
GET /api/v1alpha/tournaments/:id
{
"tournament": 1,
"bidders": [
{
"player": "p1",
"winner": true,
"prize": 2000.00,
"backers": ["b1", "b2"]
},
{
"player": "p2",
"winner": false,
"prize": 0.00,
"backers": []
}
]
}
```
### Engine endpoints
Reset the engine (database)
```sh
PUT /api/v1alpha/engine/reset
```
### Service endpoints
Service info and current statuses
```json
GET /info
{
"version": "v0.1.0",
"uptime": "1d 3h"
}
```
Service health
```sh
GET /healthz
```
Service readiness
```sh
GET /readyz
```
## Versioning automation
Using a special script to increase the release version
```sh
./bumper.sh
Current version v0.1.0.
Please enter new version [v0.1.1]:
```
## Contributing to the project
See the [contribution guidelines](docs/CONTRIBUTING.md) for information on how to
participate in the project by submitting pull requests or issues.
## Versioned changes
All changes in the project located in [changelog](docs/CHANGELOG.md)
## License
[MIT Public License](https://github.com/takama/back-friend/blob/master/LICENSE)