Registering your event at coderetreat.org

This year, registering your event at coderetreat.org is easier than it has ever been! Like a lot of other community events, we’re using a Pull Request-based process for registrations:

  1. Fork the Coderetreat git repository, current status: Build Status

  2. Create a new file called $YOURCITY.json in the _data/events/ of the repository. You can either:
    • Generate a file automatically by using this schema.

    • Generate a valid JSON below:

    The only required fields are:

    • title
    • url
    • either location.utcOffset or location.timezone
    • location.country
    • location.city

    If you want your event to show up on our map as well, please fill out location.coordinates with the coordinates of your city. You can find them by typing the city name into Google Maps (or OSM for that matter) and extracting the coordinates from the URL.

    For Berlin, Google Maps yields the following url:

    https://www.google.com/maps/@52.5187604,13.4009883,16.3z
                                 ^^^^^^^^^^ ^^^^^^^^^^
                                 Latitude   Longitude
    

    With OpenStreetMap, the URL looks like this:

    https://www.openstreetmap.org/#map=15/52.5188/13.4010
                                          ^^^^^^^ ^^^^^^^
                                          Lat.    Long.
    
  3. Run the tests locally before creating the pull request:

    cd coderetreat.github.io/ # Change into the repository
    npm install               # Install all dependencies
    npm test                  # Verify all events
    
  4. Submit a pull request from Github. Be sure your PR title is clear.

  5. Travis-CI will automatically verify that your JSON file is valid (it should show up here in the test output)

    If you would like to to run the verification of the JSON file locally, then you must have NodeJS installed on your machine.

  6. The Coderetreat coordinators will then merge your request as soon as possible.