Skip to content

Latest commit

 

History

History
96 lines (76 loc) · 6.28 KB

README.md

File metadata and controls

96 lines (76 loc) · 6.28 KB

hackalist-logo

https://img.shields.io/badge/pull%20requests%20closed%20in-6%20minutes-brightgreen.svg?style=flat-square Build Status

Node.js CI

View the current listings here.

Hackalist is a community-driven database of hackathons that has the most up to date information for all your hackathon needs. Visit our website to view the live site.

Feel free to submit Pull Requests and/or Issues. Issues can include a request to add a hackathon, bug reports, feature requests, or questions.

If you have any questions or concerns, please open an issue (with the help wanted label) or tweet @KevinPayravi.

Authorship

Site initiated by Kevin Payravi. Special thanks to:

Licensing

Site code is licensed under the MIT license.

Hackalist also utilizses some design/style elements from Skeleton, a project by Dave Gamache that is also licensed under the MIT license.

Projects Using Hackalist's API

  • Mapathon - Mapping Hackathons by Michael Ding
  • CoderCalendar, an Android app, Chrome extension, and Firefox add-on that lists upcoming coding contests and allows users to easily add them to their Google Calendar.
  • HackathonHowFar, a small Python script that outputs distance + driving time to a currently available hackathon from a given origin location.
  • Hacks, a Linux terminal client to find upcoming Hackathons near you or at a particular location.

API

The Hackalist API is composed of JSON files organized by year and month. The file system is: /api/1.0/YEAR/MONTH.json.

The API is public, so feel free to use it for your own projects. As always, a link back to Hackalist is appreciated!

Contributing

Hackalist is made possible by dozens of contributors who add hackathon listings to our JSON database. The project accepts hackathons from all around the world as long as they are open to a general populace (hackathons restricted to college students, high schoolers, or large geographic areas are great; hackathons restricted to specific companies, colleges, or cities are too narrow to be listed).

We encourage anyone to create Pull Requests to submit their favorite hackathons, as well as hackathons they find through search engines and other hackathon directories (such as Major League Hacking's listings). If you don't want to make a Pull Request, you may open an Issue to request the addition of a particular hackathon.

Hackathon listings are sorted chronology based on the starting date of the hackathon. If two hackathons start on the same day, they are sorted alphabetically.

Please ensure your JSON syntax is correct before submitting. An easy way to check your JSON synax is through JSONLint.

JSON Parameters

  • title: Name of hackathon
  • url: Official URL
  • startDate: Starting date, formatted as Month Day (e.g. August 30)
  • endDate: End date, formatted as Month Day (e.g. August 30)
  • year: Year
  • city: City hackathon is occuring in, formatted as City, State/Province Abbreviation, Country (e.g. Miami, FL, United States). If a hackathon has multiple locations (e.g. CodeDay), list as Various Locations (Country), replacing Country with a country name (or Worldwide).
  • host: The host (university, company, etc.)
  • length: Length in hours
  • size: Number of attendees; if not known, specify unknown
  • travel: Is travel reimbursed, in either part or full? yes | no | unknown
  • prize: Are prizes awarded to winners? yes | no | unknown
  • highSchoolers: Are high schoolers allowed to apply or attend? yes | no | unknown
  • cost: Cost of the event free | $10 | €10 | etc.
  • facebookURL: URL to official Facebook profile
  • twitterURL: URL to official Twitter profile
  • [DEPRECATED as of 10/16/2018] googlePlusURL: URL to official Google+ profile
  • notes: Any additional notes (limits to who can attend, special requirements, etc.)

Testing

If you want to test before submitting a pull request, you will need Node.js (12.x or higher)

To run the test, run node path/to/repo/test.js in the CLI inteface.

Listing Example

    {
      "title": "Best Hackathon",
      "url": "http://besthackathon.com/",
      "startDate": "January 20",
      "endDate": "January 21",
      "year": "2016",
      "city": "New York, NY, United States",
      "host": "Best University",
      "length": "36",
      "size": "200",
      "travel": "no",
      "prize": "yes",
      "highSchoolers": "unknown",
      "cost": "free",
      "facebookURL": "https://www.facebook.com/besthackathon",
      "twitterURL": "https://twitter.com/besthackathon",
      "googlePlusURL": "",
      "notes": ""
    }