https://github.com/topfreegames/donations

Donations is a HTTP API to control donations made by players in clans in games.
https://github.com/topfreegames/donations

Last synced: 7 months ago
JSON representation

Donations is a HTTP API to control donations made by players in clans in games.

• Host: GitHub
• URL: https://github.com/topfreegames/donations
• Owner: topfreegames
• License: mit
• Created: 2016-11-16T15:20:46.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-03T21:43:43.000Z (over 8 years ago)
• Last Synced: 2024-06-20T05:09:40.777Z (over 1 year ago)
• Language: Go
• Size: 122 KB
• Stars: 0
• Watchers: 9
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# donations

[![Build Status](https://travis-ci.org/topfreegames/donations.svg?branch=master)](https://travis-ci.org/topfreegames/donations)

[![Coverage Status](https://coveralls.io/repos/github/topfreegames/donations/badge.svg?branch=master)](https://coveralls.io/github/topfreegames/donations?branch=master)

[![Code Climate](https://codeclimate.com/github/topfreegames/donations/badges/gpa.svg)](https://codeclimate.com/github/topfreegames/donations)

[![Go Report Card](https://goreportcard.com/badge/github.com/topfreegames/donations)](https://goreportcard.com/report/github.com/topfreegames/donations)

[![Docs](https://readthedocs.org/projects/donations-api/badge/?version=latest

)](http://donations-api.readthedocs.io/en/latest/)

[![](https://imagelayers.io/badge/tfgco/donations:latest.svg)](https://imagelayers.io/?images=tfgco/donations:latest 'Donations Image Layers')

Donations is an HTTP API to control donations made by players in clans in games.

### Features

- [x] Multi-game support;

- [x] Donatable items per game;

- [x] Donation requests for items created with specific settings per game;

- [x] Donations made to donation requests;

- [x] Daily, weekly, monthly and overall donation weight per clan;

- [ ] Daily, weekly, monthly and overall donation weight per player.

## Hacking Donations

### Setup

Make sure you have go installed on your machine.

If you use homebrew you can install it with `brew install go`.

Run `make setup`.

### Running the application

Run the api with `make run`.

### Running with docker

Provided you have docker installed, to build Donations's image run:

    $ make docker-build

To run a new donations instance, run:

    $ make docker-run

### Tests

Running tests can be done with `make test`.