bholagabbar / wolfbeacon-hackalist-api

An API built around Hackalist.org data that lists all the Hackathons around you on the planet

WolfBeacon Hackalist API

An API built as a Microservice around Hackalist.org data that lists all the Hackathons around you on the planet, sorted date wise or in radial distance on entering your location coordinates.

Powered by Java using Spring-Boot, Hibernate and H2 Database Engine.

Using the API

Endpoint

/hackalist-hackathons

Updated every 12 hours from Hackalist with data present from 2016 onwards

Parameters Required:

• start-date (yyyy-MM-dd): Returns all the hackathons after this date. Eg: start-date=2015-10-10

• end-date (yyyy-MM-dd): Returns all the hackathons before this date. Eg: end-date=2015-12-10

• sort-by:

  1. distance (sort-by, latitude, longitude): Sorts all the Hackathons in ascending radial order from the coordinates entered. Eg: sort-by=distance&latitude=19.1231&longitude=45.1231 OR
  2. date (sort-by): Sorts all the Hackathons in ascending order of start-date. Eg: sort-by=date

Example Query 1 (By date):

curl -X GET "https://wolfbeacon.com/api/hackalist-hackathons?start-date=2016-01-01&end-date=2016-01-30&sort-by=date"

Example Query 2 (By distance/coordinates):

curl -X GET "https://wolfbeacon.com/api/hackalist-hackathons?start-date=2016-01-01&end-date=2016-01-30&sort-by=distance&latitude=40.7127837&longitude=-74.00594130000002"

Result:

{
  ...
    {
    "id": 20160916552226390,
    "title": "Hack the North",
    "eventLink": "https://hackthenorth.com/",
    "startDate": "2016-09-15",
    "endDate": "2016-09-17",
    "lastUpdatedDate": "2016-11-13T00:00:00.000+0000",
    "year": 2016,
    "location": "Waterloo, ON, Canada",
    "host": "Hack the North",
    "length": 36,
    "size": "1000",
    "travel": true,
    "prize": true,
    "highSchoolers": true,
    "cost": "free",
    "facebookLink": "https://www.facebook.com/hackthenorth",
    "twitterLink": "https://twitter.com/hackthenorth",
    "googlePlusLink": "",
    "imageLink": "https://scontent.xx.fbcdn.net/v/t1.0-1/p100x100/13501875_1423460301013883_426092165374437510_n.png?oh=23ff635c68eee2faa74b376adc7982fd&oe=58CE1F88",
    "latitude": 43.4642578,
    "longitude": -80.5204096,
    "notes": ""
    },
  ...
}

Ping Endpoint

/ping/wolfbeacon-hackalist-api returns ping successful.

Local Setup:

Dependencies: Java 8, Maven.

• git clone https://github.com/wolfbeacon/wolfbeacon-server
• Rename applications-test.properties to application.properties and enter the configuration details as given
• mvn dependency:resolve && mvn clean package
• cd target
• java -jar wolfbeacon-hackalist-api-1.0.jar

Running/Deploying with Docker

• sudo docker service start
• sudo docker build -t wolfbeacon-hackalist-api .
• sudo docker run -p 8080:80 wolfbeacon-hackalist-api