Skip to content

Latest commit

 

History

History
237 lines (158 loc) · 12.1 KB

README.md

File metadata and controls

237 lines (158 loc) · 12.1 KB
Raw

Open Event webapp

The Open Event Web App project has two components a) an event website generator and b) the actual generated website output. 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).

Build Status Heroku Dependencies Codacy Badge Code Climate codecov Gitter

Communication

Please join our mailing list to discuss questions regarding the project: https://groups.google.com/forum/#!forum/open-event

Our chat channel is on gitter here: https://gitter.im/fossasia/open-event-webapp

1. Event Website Output

The component that is generator from the web app are the event websites. A sample event site using the sample from the open-event repo was generated and added to this repo as a Github Pages site. You can see the live site at http://fossasia.github.io/open-event-webapp/

2. Web App Generator

Components and Technology

Technologies used

The webapp generator uses the following technologies -

  1. HTML/CSS/Javascript based frontend
  2. SASS - SASS to write optimized CSS.
  3. Node.js - Javascript for the generator backend
  4. Express.js - Server framework
  5. Handelbars - Template for rendering
  6. Socket.io - For handling multi-user client, with progress of upload/generation

Components of the Generator

  1. Webform

The source of the webform can be found here. It consists of -

  • index.html - The webform page
  • form.js - The script that uploads the zips, and starts the generator process
  1. Generator

The generator runs on a ExpressJS server, using this main app script.

  1. Scripts
  • generator.js - Does the main generation tasks, and controls other scripts
  • fold.js - Groups data of sessions, speakers, tracks etc from JSONs
  • dist.js - Creates folders, cleans folders, unzips/zips packages
  • ftpdeploy.js - Deploys finished website to organiser's server (optional)
  • mailer.js - Sends mail to organiser notifying of successful creation
  • buildlogger.js - Displays build logs while generating webapp
  • deploy.js - Automatically deploys generated event sites to user's github account
  • gulpfile.js - Creates minified js and css for generated webapp
  1. Templates

The HTML pages of the generated website are created using Handelbars templates. You can find all the templates here -

  • footer.hbs : Common template for footer on all pages
  • navbar.hbs : Common template for navbar on all pages
  • event.hbs : index.html - Home page
  • rooms.hbs : rooms.html - Venues page
  • schedule.hbs : tracks.html - Tracks page
  • speakers.hbs : speakers.html - Speakers page

Web App Generator Test Installation

You can try out the web generator at https://opev-webgen.herokuapp.com

The 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

Installation/Deployment of the Web App Generator

How do I install Web App Generator on a Server

Please check out the documentation here.

How do I install Web App Generator on my local machine

Please check out the documentation here.

How do I install Web App Generator on Google Cloud

To install the system on Google Cloud please refer to the Google Cloud installation readme.

How do I install Web App Generator on AWS

To install the system on AWS please refer to the AWS installation readme.

How do I install Web App Generator on Digital Ocean

To install the system on Digital Ocean please refer to the Digital Ocean installation readme.

How do I deploy Web App Generator with Heroku

Please read how to deploy to Heroku here
Or use the 1-click deployment button
Deploy

Accessing the Generator Web Form

Generator Screencast

  • Add your email id, name of app (name of event),

  • 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.

Accessing the Generator via REST API

Endpoints

POST /generate

Parameters (x-www-form-urlencoded) or json

Parameter Description Purpose
name (required) Name of the webapp Unique name of the webapp
email (required) Your email id We will send a email to this when your webapp is ready
datasource (required) Either jsonupload or eventapi
apiendpoint (if datasource = eventapi) API endpoint url

Configurations

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.

Server Configs

PORT

Variable Description
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)

Mailer

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 Sendgrid Key.

Variable Description
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)

Upload

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.

Variable Description
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)

Github Deploy

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 node.

Variable Description
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)

Images

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)

Audio

Some sessions can have a recorded audio attached to them. The parameters for that are

Variable Description
config.audio_files.MAX_SIZE_MB Max size of the audio (limited by Github file size)

Contributions, Bug Reports, Feature Requests

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 https://github.com/fossasia/open-event-webapp/issues

Issue and Branch Policy

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

  • development
    All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to development. PRs to master must pass a build check and a unit-test (test/serverTest.js) check on Travis
  • master
    This contains shipped code. After significant features/bugfixes are accumulated on development, we make a version update, and make a release.

LICENSE

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/.

Maintainers

The project is maintained by