Skip to content

The Agenda PWA (progressive web app) for your conference!

Notifications You must be signed in to change notification settings

awsugkochi/lanyard

 
 

Repository files navigation

Lanyard

All Contributors

Lanyard was originally created by us for our community event AWS Community Day. It became popular in the community because of ease of use and well thought-out inteface. Quickly other communities wanted to use this app & we helped them get up and running. This made us think there may be many more organizers who woould love to use something like Lanyard & hence we decided to open-source the project

amplifybutton

Features:

Time Aware

When you open the app, it always displays what's currently happening based on time, right in your face, no scrolling through endless agenda table

Make Your Own Schedule

Let's users to make their own schedule for mult-track events and accordingly highlights the scheduled track at that time.

Talk Level Feedback

We all know that feedback at the end of the event is broken and very less useful. Lanyard allows attendees give feedback for the talk right after it is finished, collecting the feedback when the talk is still fresh in the head.

Progressive Web App (PWA)

No App Stores, No installation, just load the URL and tap "Add to Home Screen", use it for the event & remove it later.

Works offline!

Having a decent network connectivity at the event is always a challenge. Lanyard takes advantage of local storage & once it's loaded, it can completely work offline (except for submitting feedback).

Kiosk Mode (Coming Soon)

As an organiser if you want to display agenda on a vertically mounted display, you could use Kiosk mode of Lanyard. Just like the normal version, it is time-aware and will always display currently running talk, it's plug & play! Kiosk mode also sports a QR code for people to scan and get this on their phone.

Run Locally/Dev

Clone this repository

git clone [email protected]:antstackio/lanyard.git
cd lanyard

Install Dependencies & Run!

npm install
npm run start

Configuration

To customize this app for you conference, start with config/website.js & edit the details accordingly

module.exports = {
  siteTitle: "Lanyard", // Navigation and Site Title
  siteTitleShort: "Lanyard", // short_name for manifest
  siteLogo: "images/logo.png", // Used for SEO and manifest, path to your image you placed in the 'static' folder
  siteDescription: "The Agenda PWA for your Conference.",

  // Manifest and Progress color
  themeColor: "#1E2A39", //
  backgroundColor: "#ffffff",
}

Adding Your Agenda

To add agenda you will have to modify/create src/data/agenda.json

  • Slots - Array of slots, slots are time-based & cuts across "tracks"
  • Each slot will have array of tracks
  • Each track will have it's meta like 'title' & also array of 'speakers'

Example: Say you have an event which has 3 tracks (say Track1, Track2, Track3) & goes from 10AM to 11:30AM and each slot is 30 mins

  • You will have 3 slots, 10:00 - 10:30, 10:30 - 11:00, 11:00 to 11:30
  • Each slot will three tracks, Track1, Track2, Track3
  • Each of these tracks will have talk meta & speaker information. Tracks must have a unique trackId.

Tea Breaks, Lunch etc & Merging Tracks

To mark a slot as a non-talk slot, make slotType value to be "break". To merge tracks for few talks/breaks, set trackLength appropriately. If you want to merge all 3 tracks like in example above, trackLength should be set to 3.

Deploying

Lanyard is configured with one-click deploy with AWS Amplify. All you need to do is click "Deploy on AWS", connect with Github, select your forked repo with your customisations and follow along. AWS Amplify will also deploy the required backend for the app, basically an API to capture event feedback. So it creates API Garetway -> Lambda -> DynamoDB setup for this & all the submitted feedback will be stored in DynamoDB for you to access later.

Hosted Solutions

We will be launching our hosted solution on lanyard.app but in the meantime if you need us to get this up and running for your conference, get in touch at [email protected]

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Code of Conduct

License

MIT

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Prashanth HN
Prashanth HN

💻 📖
Raalzz
Raalzz

💻
Praveen Kumar Gorakala
Praveen Kumar Gorakala

💻
krishnamuddi
krishnamuddi

💻
Vishwas Navada K
Vishwas Navada K

📖

This project follows the all-contributors specification. Contributions of any kind welcome!

About

The Agenda PWA (progressive web app) for your conference!

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.0%
  • CSS 1.0%