LinkFree Events Documentation

Here you should find everything you need from getting started with creating your Profile to more advanced topics. We welcome contributions, check out the LinkFree Repo and the documentation source on GitHub for more information.

Events

Hosting or attending events, let people know what you are up to by adding these events to your Profile.

Example of LinkFree Profile events

All future events also appear on the Events page for the app.

Example of LinkFree events

Add Event

Create a folder that matches your GitHub username in the data directory and then in that folder create another folder called events. For example data/eddiejaoude/events/
In your folder add a json file with any name you like. We recommend putting the date first and then appending it with the event name. For example 2023-09-13-javascript-conference.json.

If you need help on how to edit this file, please see the Editing Guide

This json file will contain one object for the event and must have these six fields: isVirtual and/or isInPerson, color, name, description, date, url, and location (this field will be required only when isInPerson is true). It can also optionally include other fields. For instance: userStatus & speakingTopic. It will look like this:

{
  "isVirtual": true,
  "isInPerson": true,
  "color": "red",
  "name": "Open Source GitHub reviews",
  "description": "In this livestream I will be going reviewing your **Open Source projects** and profiles! I will be joined by **Amanda**, a Developer Advocate.",
  "date": {
    "start": "2022-12-09T16:00:00.000+00:00",
    "end": "2022-12-09T17:00:00.000+00:00",
    "cfpClose": "2022-10-09T17:00:00.000+00:00"
  },
  "url": "https://www.youtube.com/watch?v=iqIFD02OkVE",
  "price": {
    "startingFrom": 0
  },
  "location": {
    "road": "Messe Berlin South Entrance & CityCube",
    "city": "Jafféstrasse",
    "state": "Berlin",
    "country": "Germany"
  },
  "userStatus": "speaking",
  "speakingTopic": "Open Source"
}

Property	Required	Description
isVirtual / isInPerson	true	Is the event virtual or in person or both
color	true	What color would you like this milestone to be displayed in
name	true	Name of the event
description	true	More details about the event, this can include markdown
date	true	Start and end date plus time of the event
url	true	Where can people learn more about the event
cfpClose	false	The date of when the CFP to submit a talk closes
location	true/false	Address of the event venue (required only when `isInPerson` is true)
userStatus	false	What your role is at the event
speakingTopic	false	The topic of the event
price	false	What is the cost to attend event in USD.

Location property	Required	Description
road	false	In which road, the event is hosting
city	false	In which city, the event is hosting
state	false	In which state, the event is hosting
country	false	In which country, the event is hosting

Now you can commit your file and create a Pull Request. For more details please see Editing Guide

If you want to know how to properly add start, end, and CFP Close times, feel free to check Unix Time stamp.