Bingo is a service which allows users to get Lucky Draw Raffle tickets and use one ticket to participate in a lucky draw game. Draw a ticket and win exciting prizes!

• Setting up Bingo
  • Clone Bingo
  • Install dependencies
    • Install python dependencies
    • Install node dependencies
  • Initialize the database
  • Set up the results computation cron job
  • Run Bingo
• API Endpoints
  • /lucky-draw/raffle/<int:raffle_id> [GET]
  • /lucky-draw/past-raffles [GET]
  • /lucky-draw/last-week-raffles [GET]
  • /lucky-draw/next-raffle [GET]
  • /lucky-draw/upcoming-raffles [GET]
  • /lucky-draw/ongoing-raffles[GET]
  • /lucky-draw/draw-ticket [POST]
  • /lucky-draw/tickets [GET]
  • /lucky-draw/raffle/<int:raffle_id>/enter [POST]
  • /lucky-draw/create-raffle [POST]

Bingo is hosted on GitHub at https://github.com/shivam-kapila/Bingo/. You can use git to clone it to your computer

git clone https://github.com/shivam-kapila/Bingo.git

To work on the project, you first need to install Python, Node.js and PostgreSQL. Follow the respective links and download them for your platform.

Install virtualenv using the command:

pip install virtualenv

Move into the project directory and create a virtual environment, and install the python dependencies by running the following commands:

virtualenv bingo
source bingo/bin/activate
pip install -r requirements.txt

Install the node dependencies using the command:

npm install

The dependencies have been installed and you are good to proceed.

To initialize the database for the first time, run the following command:

./develop.sh init_db --create-db

In case you need to reset the database, run:

./develop.sh init_db -f

Note: In case of the error peer authentication failed for user "postgres", follow the steps given here.

The results of lucky draw raffles are calculated, by invoking the compute_results.py file every hour. To setup this cron job run:

./develop.sh cron

This creates a user bingo if it doesn't exist and adds the new cron job to the existing ones.

Now the project is setup and ready to run. To run the project run the given command.

./develop.sh

Additionally you can specify the host, port and debug values, to run the Flask server like this:

./develop.sh ---host=<host> --port=<port> -debug

or use the shorthand flags as follows:

./develop.sh-h=<host> -p=<port> -d

All these API endpoints require a valid Authorization Header of the form Token <auth_token>.

Get raffle with the given raffle_id. Returns the raffle applicants too, in case the user is an admin.

Headers:

• Authorization: Token auth_token

Returns:

• raffle: the raffle record for the given raffle_id.

Headers:

• Authorization: Token auth_token

Returns:

• raffles: the list of raffles.

Get a list of last week raffles.

Headers:

• Authorization: Token auth_token

Returns:

• raffles: the list of raffles.

Headers:

• Authorization: Token auth_token

Get the next raffle.

Returns:

• raffle: the next raffle.

Get a list of upcoming raffles.

Headers:

• Authorization: Token auth_token

Returns:

• raffles: the list of raffles.

Get a list of ongoing raffles.

Headers:

• Authorization: Token auth_token

Returns:

• raffles: the list of raffles.

Draw a new ticket for the given user.

Headers:

• Authorization: Token auth_token

Returns:

• ticket: the newly drawn ticket.

""" Get a given user's tickets.

Headers:

• Authorization: Token auth_token

Returns:

• tickets: the tickets of the given user.

Create an entry for the given user for the raffle raffle_id. The earliest valid non-redeemed ticket is used to enter the raffle. Headers:

• Authorization: Token auth_token

Raises:

• BadRequest(404): The user has no valid non-redeemed tickets
• BadRequest(404): The raffle doesn't exist
• BadRequest(404): The raffle entries are closed
• Conflict(409): The user has already entered the raffle

Create a new raffle. This endpoint is admin only.

Headers:

• Authorization: Token auth_token

Raises:

• BadRequest(401): The user is not an authorized admin
• BadRequest(404): Incomplete form POSTed

Returns:

• raffle_id: the id of the newly created raffle.