The Open Event Web App project has TWO components :
The web generator application can generate event websites by getting data from event
JSON files and binary media files, that are stored in a compressed zip file. You can also access the application through a
REST API. Websites that are generated by the "web app generator" can be uploaded to any web location, e.g. on Github pages or any server (e.g. via ftp).
Please join our mailing list to discuss questions regarding the project :
Our chat channel is on gitter here:
The component that is generated from the web app is the event website. Several sample event sites using the sample from the open-event repo were generated, showcased on the main index page and added to this repo as a Github Pages site. You can have a look at showcase page on http://fossasia.github.io/open-event-webapp/ We also have a custom domain at http://sched.eventyay.com to which the former link is redirected.
The webapp generator uses the following technologies :-
2. SASS - SASS to write optimized CSS.
4. Express.js - Server framework
5. Handelbars - Template for rendering
6. Socket.io - For handling multi-user client, with progress of upload/generation
The source of the webform can be found here.
It consists of :-
The generator runs on a ExpressJS server, using this main app script.
The HTML pages of the generated website are created using Handelbars templates.
You can find all the templates here -
Contains scripts related to testing different pages of the generated website.
The Open Event Project enables the exchange of data between all components as well as with other services through a standardized Format. The Open Event repository provides a sample implementation of the format. It includes
JSONfiles for all relevant event information and binary data for images and audio files.
The Open Event Server enables organizers to manage events from concerts to conferences and meetups. It offers features for events with several tracks and venues. Event managers can create invitation forms for speakers and build schedules in a Drag & Drop interface. The event information is stored in a database, which can be a
sqlite-dbfile or saved in
jsonitself. The system provides API endpoints to fetch the data, and to modify and update it. Organizers can import and export event data in a standard compressed file format that includes the event data in
JSONand binary media files like images and audio.
The Open Event Android Project consists of two components. The App Generator is hosted web application, that is hosted on a server and generates an event Android app from a zip with
JSONand binary files (examples here) or through an API. The second component we are developing in the project is generic Android app - the output of the app generator. The mobile app can be installed on any Android device for browsing information about the event. Updates can be made automatically through API endpoint connections from an online source (e.g. server), which needs to defined in the provided event zip with the
JSONfiles. The Android app has a standard configuration file, that sets the details of the app (e.g. color scheme, logo of event, link to
6. Overview Site
Contains thumbnail images of sample events and main index.html file required for the showcase site
You can try out the web generator at https://opev-webgen.herokuapp.com
development-version is available here: https://opev-webgen-dev.herokuapp.com
You can use one of the event sample zip files here: https://github.com/fossasia/open-event/tree/master/sample
Please check out the documentation here.
Please check out the documentation here.
To install the system on Google Cloud please refer to the Google Cloud installation readme.
To install the system on AWS please refer to the AWS installation readme.
To install the system on Digital Ocean please refer to the Digital Ocean installation readme.
Please read how to deploy to Heroku here
Or use the 1-click deployment button
Add your email id, select session style (single page for each session or expandable sessions),
Then upload the zip file that contains all JSON files for speakers, sessions, sponsors, event, tracks and locations (These you should get from an orga-server or through the API after you have created your event there).
Now, when you click on GENERATE APP and DOWNLOAD button, you'll get to download a zip of the event website. You can also deploy the web site to your Github Pages by clicking on DEPLOY button.
eventapiapiendpoint (if datasource = eventapi) API endpoint url
All configurations are saved in the config.js file.
NOTE: In this document all
config.<obj> variables refer to the data in the config.json file.
process.env.PORT(Can be described in shell env, or in Heroku type platforms)
config.PORT(Falls back to config file if above not found)
We use Sendgrid to send mails, and you need a
Sendgrid API to make it work. Additionally, you can also use
SMTP to send mails if you don't have
process.env.SENDGRID_API_KEY(Tries to get from shell env first)
config.SENDGRID_API_KEY(Falls back to config file)
process.env.SMTP_USERNAME(Tries to get from shell env first)
config.SMTP_USERNAME(Falls back to config file)
process.env.SMTP_PASSWORD(Tries to get from shell env first)
config.SMTP_PASSWORD(Falls back to config file)
We use AWS S3 services for storing the zip file of the generated event. These zip files are automatically deleted after 3 days from the store.
Each uploaded file has a unique download link.
node-uuid module is used for generating the cryptic download link of the file.
process.env.AWS_BUCKET(Tries to get from shell env first)
config.AWS_BUCKET(Falls back to config file)
process.env.AWS_ACCESS_KEY_ID(Tries to get from shell env first)
config.AWS_ACCESS_KEY_ID(Falls back to config file)
process.env.AWS_SECRET_ACCESS_KEY(Tries to get from shell env first)
config.AWS_SECRET_ACCESS_KEY(Falls back to config file)
The web-app is able to automatically deploy the generated event sites to Github Pages of a User. We use
passport library for authentication of the user. For uploading and committing the event files, we use
github library which provides a wrapper for the Github API in
process.env.GITHUB_CLIENT_ID(Tries to get from shell env first)
config.GITHUB_CLIENT_ID(Falls back to config file)
process.env.GITHUB_CLIENT_SECRET(Tries to get from shell env first)
config.GITHUB_CLIENT_SECRET(Falls back to config file)
process.env.CALLBACK_URL(Tries to get from shell env first)
config.CALLBACK_URL(Falls back to config file)
We need to process all the speaker images and there are certain configs used -Variable Description
config.speaker_images.MAX_WIDTH(Max needed height of speaker image)
config.speaker_images.MAX_HEIGHT(Max needed width of speaker image)
config.speaker_images.TRACK_HEIGHT_REM(Speaker image height, in CSS rem units, for tracks page)
config.speaker_images.TRACK_WIDTH_REM(Speaker image width, in CSS rem units, for tracks page)
Some sessions can have a recorded audio attached to them. The parameters for that are -Variable Description
config.audio_files.MAX_SIZE_MBMax size of the audio (limited by Github file size)
This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well.
Please report issues here
Before making a pull request, please file an issue. So, other developers have the chance to give feedback or discuss details. Match every pull request with an issue please and add the issue number in description e.g. like "Fixes #123".
We have the following branches :-
Feature Requests and Bug Reports
Join the development
If you want to run tests locally, first install the following:
npm install --no-save mocha chromedriver
You can then run the full test suite with:
or you can run one individual test script like this:
npx mocha -b test/generatorAndSchedule.js
OpenEvent Webapp - A webapp and it's generator, written under the FOSSASIA Open Event project. The Open Event project aims to make server and client software required for hosting events/conferences easy to build and configure. Copyright (C) 2016, FOSSASIA. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
The Project is maintained by :-