bedrockstreaming/babitch

⛔️ DEPRECATED - Babitch is a project to record table soccer scores, archive them, and make them easily accessible for further analysis using a REST API.

Babitch

Many companies all over the world uses table soccer to build team spirit. Babitch is a project to record table soccer scores, archive them, and make them easily accessible for further analysis using a REST API.

Installation

Clone the project

$ git clone https://github.com/M6Web/Babitch.git
$ cd Babitch

Install dependencies

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar install

Configure database connection

$ cp app/config/parameters.yml.dist app/config/parameters.yml

Edit this new file to setup your MySQL connection.

Use

The API documentation is available at http://babitch-server/api/doc/
Thanks to Stage1, you can access our master branch staging environment : http://master.m6web.babitch.stage1.io/api/doc/

Then, you have to create a client to access Babitch's API, or you can use ours : BabitchClient

Installation for dev

Clone the project

$ git clone https://github.com/M6Web/Babitch.git
$ cd Babitch

Install Vagrant and configure Vagrantfile :

$ cp Vagrantfile.dist Vagrantfile

Note : configure your own Vagrantfile if necessary.

$ vagrant up
$ vagrant ssh
$ cd /vagrant

Create MySQL database

$ mysql -uroot -e "CREATE DATABASE babitch DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;"

Install dependencies

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar install

Note : select default values to all questions.

Load fixtures

$  php app/console doctrine:fixture:load

You can now access the API doc at http://localhost:8888/api/doc.

Tests

Create test database

php app/console doctrine:database:create --env=test
php app/console doctrine:schema:create --env=test

Run tests

php bin/behat

Docker

To use Docker as simple user (logout after this command):

sudo usermod -aG docker $USER

Then deploy Babitch using deploy.sh script:

./docker/deploy.sh

Or manually copy sources into docker/webapp/sources/ directory and run the command below:

docker-compose up -d

You now have a Babitch instance listening on port 8081, Mysql on port 3306 and PHP-FPM on port 9000!

Credits

Developped by the Cytron Team of M6 Web.

License

Babitch is licensed under the MIT license.

babitch's Issues

Status page

Create a /status route, returning a 200 HTTP code, and some basic stats.

Know position of all players on autogoal

Today, only the goaler and conceider information are sent on a goals.
The problem is that on autogoal, it's impossible to know players position of the other team.

Any idea ?

Because, it's a problem for some stats :

• Number of goals conceided by ballsplayed when on defense
• Number of goals score by ballsplayed when on attack
  ...

Players API limit to 20 players

Is it possible to rise the limit per page to 50 element instead of 20 ?
Because, now, some players can't be selected in the client side because of the pagination. it will be painful to do multiple requests for having all clients in the BabitchClient

Add timestamp on each Goal

Post player doesn't work in api/doc

The two fields available in the api/doc sandbox post v1/players doesn't work (422 unprocessable entity)

Instead of "player[name]" and "player[email]", the api needs only "mail" and "email"

per_page params on Games route is limited to 100

http://api.babitch.m6web.fr/v1/games?per_page=300 give the same output as http://api.babitch.m6web.fr/v1/games?per_page=100 and return only 100 games

Is this normal ?

Add two timestamp to Game Entity

Add two timestamp in the game entity :

• GameStart
• GameEnd

Add a league filter on game route

master.m6web.babitch.stage1.io/api/doc/ return HTTP_504

The link in readme.md for api documentation seems broken (tested one week ago and today from home and from work).