mini-conf / mini-conf Goto Github PK

Run a conference from your backyard.

Home Page: https://mini-conf.github.io/index.html

License: MIT License

Python 4.47% CSS 1.70% JavaScript 86.54% HTML 6.92% Makefile 0.29% Shell 0.08%

mini-conf's Introduction

MiniConf

MiniConf is a virtual conference in a box. It manages the papers, schedules, and speakers for an academic conference run virtually. It can be easily integrated with interactive tools such as video, chat, and QA.

MiniConf was originally built to host ICLR 2020 a virtual conference with 6000 participants and have been used to host a wide variety of major conferences.

It is designed to be:

Run based on static files hosted by any server.
Modifiable without a database using CSV files.
Easy to extend to fit any backend or additional frontend tools.

Links

Demo system: http://www.mini-conf.org

Source Code: https://github.com/Mini-Conf/Mini-Conf

Get Started

> pip install -r requirements.txt
> make run

When you are ready to deploy run make freeze to get a static version of the site in the build folder.

Tour

The MiniConf repo:

Datastore sitedata/

Collection of CSV files representing the papers, speakers, workshops, and other important information for the conference.

Routing main.py

One file flask-server handles simple data preprocessing and site navigation.

Templates templates/

Contains all the pages for the site. See base.html for the master page and components.html for core components.

Frontend static/

Contains frontend components like the default css, images, and javascript libs.

Scripts scripts/

Contains additional preprocessing to add visualizations, recommendations, schedules to the conference.

For importing calendars as schedule see scripts/README_Schedule.md

Extensions

MiniConf is designed to be a completely static solution. However it is designed to integrate well with dynamic third-party solutions. We directly support the following providers:

Rocket.Chat: The chat/ directory contains descriptions for setting up a hosted Rocket.Chat instance and for embedding chat rooms on individual paper pages. You can either buy a hosted setting from Rocket.chat or we include instructions for running your own scalable instance through sloppy.io.
Auth0 : The code can integrate through Auth0.com to provide both page login (through javascript gating) and OAuth SSO with Rocket Chat. The documentation on Auth0 is very easy to follow, you simply need to create an Application for both the MiniConf site and the Rocket.Chat server. You then enter in the Client keys to the appropriate configs.
SlidesLive: It is easy to embedded any video provider -> YouTube, Vimeo, etc. However we have had great experience with SlidesLive and recommend them as a host. We include a slideslive example on the main page.
PDF.js: For conferences that use posters it is easy to include an embedded pdf on poster pages. An example is given.

Acknowledgements

MiniConf was built by Hendrik Strobelt and Sasha Rush.

Thanks to Darren Nelson for the original design sketches. Shakir Mohamed, Martha White, Kyunghyun Cho, Lee Campbell, and Adam White for planning and feedback. Hao Fang, Junaid Rahim, Jake Tae, Yasser Souri, Soumya Chatterjee, and Ankshita Gupta for contributions.

Citation

Feel free to cite MiniConf:

@misc{RushStrobelt2020,
    title={MiniConf -- A Virtual Conference Framework},
    author={Alexander M. Rush and Hendrik Strobelt},
    year={2020},
    eprint={2007.12238},
    archivePrefix={arXiv},
    primaryClass={cs.HC}
}

mini-conf's People

Contributors

Stargazers

Watchers

Forkers

acl-org manoja328 codeaudit animesh-007 manal-almodala rohanvakharia shirishbahirat guyaglionby genxplus fritexvz ryanmcgary rockt ktertikas mvanzorn arpansriv milovanderlinden muthukrishna piperod khemanta anaerobeth australasian-computer-music-association tejank10 ahli-org hlgrprng akbc-conference nhanwei sameersingh almartel h0m3brew summertown-lab vukosim silky tompollard halokim sjtubblythe abdelpakey dakuo eric-haibin-lin bguedj ui-frontend carlosal1015 p16i jawalnix python-spain ndfcampbell ismir spetruzza stites keshava jjsullivan5196 lancescrazy mneunhoe ohbm-wannabe schochastics ronalchan jhoffman aadsah dedeshat ahaldar daeyounglim mjkim1001 andyprasetya coursekevin robbriers davidaknowles awesome-archive up-mitc-ds juancarlosruizcarrillo yingjerkao stephenfreund surbhi18 tovacinni baylearn-org haoxue-fan vikramp1100 jlorencelim cpmpercussion burakcanbiner ajstent inlgmeeting sithankanna gg-big-org villalbamartin lujiaying colm-org dave-sbs rverschae

mini-conf's Issues

Deployment tools

Make it super easy to deploy to gh-pages or somewhere else that hosts static sites.

"Create your own schedule"

I really liked the option to easily create your own schedule that was used at NAACL 2019 (https://naacl2019.org/schedule/). It would be useful if it could also be organized in various ways (e.g., by date and time, or by track) and exported.

It would save time for people who are (a) trying to figure out which papers to attend given their interests, time zones, and other constraints, and then quickly look up when to log-in to each paper's QA session, and (b) perhaps be the starting point for a user to write notes on the conference (e.g., something like what I tried to do here: https://github.com/juand-r/ICLR-2020 , although that is very incomplete).

Search by relevance

First of all congratulations on the amazing app! I love using the service for different conferences.

I was wondering how you would like to add a feature of searching conference papers by relevance in addition to the exact match feature that is currently implemented. Users will be able to query either by keywords or abstract of a recent article they are working on and the service will set a 'relevant' documents from the list of papers in a conference. The relevancy will be judged solely based on the title and the abstract of the papers of the conference. We can implement a BM-25 based retrieval model or use SciBert embeddings to retrieve the relevant list of documents.

The only con for this idea is that the solution won't be static. However, let me know if you like the idea and I would love to work on it and contribute to the project! :)

Reference of inspiration for the idea comes from this BIR paper

Add paper search by keywords

Please make it possible to search papers by keyword (single or multiple), in addition to by title and by author.

dead?

I am curious if mini-conf is still alive and being used, or what alternative solutions people went for instead?

Add a list for checked papers

Although the checked papers have a different color in the paper visualization panel, it would be helpful to have a list of all checked papers.

rocket chat on demo website doesn't work

e.g going to a "Chat" or specific poster, e.g. http://www.mini-conf.org/poster_H1gDNyrKDS.html it just shows the button for MINCONF which if I click -- no chat appears

I just wondered if it is known etc

Jinjia template for Cards

More than one "track" per paper

I liked how the site allowed one to filter papers by session and by track, but unfortunately it is easy to skip interesting papers within a give topic like this. For example, "Posterior Control of Blackbox Generation" by Li and Rush was in the "Machine Learning for NLP" track, rather than the "Generation" track.

Is it possible to assign more than one category for each paper?

demo page / landing == tutorial

Integration with Jitsi

Wow, if I only knew you existed 2 weeks ago. During OHBM conference we had to quickly establish an "alternative" poster session to the one provided by a commercial solution. You can see it in action at https://datalad-datasets.github.io/ohbm2020-posters/ . The savior was free https://meet.jit.si which allowed to "mint" rooms per each poster. Later EtherPad was bolted on to provide persistent notes etc. May be it would give ideas ;)

Cheers and thank you for the GREAT WORK!

Missing poster HTML file

After ./run.py, on the page http://127.0.0.1:5000/calendar.html#tab-day, if I click one of the poster at the bottom, it returns 404 not found.

simple getting-started scripts

embedding based on arxive HF
keywords based on counting NN phrases
image extraction based on simple strict

Fix titles

Add titles to all the pages.

Deploy inline.

make deploy Configuration to deploy directly to a gh-pages in the same repo.

Direct integration with softconf/cmt/openreview

Reusable scripts for conversion.

V2

Easier robust Chat solution
Templates
Accessibility
Personalization / Authentication

Integrate an open-source chat system.

We would like to have a default chat system built in with a script that creates chat rooms for each paper.

One idea would be to use rocket.chat, but maybe there is something with a better license.

Public / Protected Variable

Choose timezone and remember it across webpages

Currently the ACL2020 virtual conference website allows people to choose timezone in the "Schedule" page, but people get confused why their selected timezone isn't reflected in other pages.

It may be useful for Mini-Conf to have a timezone dropdown menu in the header (or somewhere else) and use local cookie to remember the selection. Then we can always display the selected timezone for individual sessions.
I guess it can go into https://github.com/Mini-Conf/Mini-Conf/blob/master/templates/base.html

Only allow "squash and merge"

I notice that the master commit history contains intermediate commits for PRs.
Probably good to always do "Squash and merge".

Can be done by in "Settings".

Issue with timezones

Hi, I have an issue with timezones. All dates are given 2-10 PM CEST (UTC+2) in the JSON file.
I am currently looking into static/js/views/calendar.js, I will let you know if I find a fix.
Possibly an update to tui.calendar v1.13 would fix?

Replace https://fonts.googleapis.com

It seems that we are using some css files from https://fonts.googleapis.com.
https://github.com/Mini-Conf/Mini-Conf/blob/master/templates/base.html#L45-L53
These may not work in some areas like mainland China.
Is there an alternative for these files?

Make 'list' mode actually a list

Request to have a list/table like view when you click this button.

Set up Github Issue Template

It may be good to have separate issues for feature request & bug report, similar to here.

We can probably adapt their template here.

SlidesLive not loading for ICML, but works correctly for ACL.

SlidesLive for individual papers is not loading for ICML for some reason. However, It works fine at ACL virtual website. I opened both from the same browser (Firefox), same machine (Ubuntu), even same window, etc.

Please find the screenshots for both below:

SlidesLive (ICML):

Here's the link the screenshot shows

SlidesLive (ACL):

Is there some configuration difference between the two?

freeze.sh doesn't work

I got this error message when running ./freeze.sh and no files are generated.

./env/lib/python3.7/site-packages/flask_frozen/__init__.py:199: MissingURLGeneratorWarning: Nothing frozen for endpoints send_static. Did you forget a URL generator?
  return set(page.url for page in self.freeze_yield())

Automatic keyword generation

Some clever way of generating keywords.

Clean up markup.

The markup is a bit sloppy. Someone who is an expert in bootstrap could likely do it in a cleaner way.

Document live integrations

Several people have requested integrations with live tools:

slido
presence (who is looking at this page)
zoom
YouTube / twitch

Would be nice to have documentation of how to do these, integration points.

Document AWS login / auth strategy

Not sure how to do this statically but it seems worth trying.

MCSDMS: Mini-Conf /sitedata management systems/setups

I wonder what setups/systems people use/recommend to manage/populate sitedata and related content? E.g. for a conference with a few 1,000 of participants who need to upload their posters (pdfs) and pre-recorded talks -- how could it be streamlined.

Clean up CDN

We get the javascript from several different CDNs would be nice to standardize.

Code comments for where to add custom stuff

e.g. where to change:

landing page welcome content
card layout
button colors / bg colors / main font

RocketChat integration issue

There are a few issues with RocketChat integration.

When I visit https://mini-conf.github.io/chat.html and click "Chat", I got a blank page. The console shows the error below. This probably can be fixed by using "https" instead of "http".
According to RocketChat tech support (via email),

once Iframe auth is enabled you won't be able to access the default login page - the workaround here will be to execute the following code on every login: Meteor.loginWithPassword('username-or-email', 'your-password'); - more about this workaround and the Iframe auth in general you can check in this guide.

Not sure how to resolve this. I'll look into some options. But I wonder how ICLR addressed this issue? @srush

calender should link to session filters in /paper

https://twitter.com/yoavgo/status/1280023845601148929

This was the PR from ICLR

ICLR/iclr.github.io@7f9d73a

Faster Static File Generation

Make Flask freeze faster