The Open Event Web App project has two components a) a 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).
##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-web-app
The component that is generator from the web app are the event websites. A sample event site that was generated is added to this repo as a Github Pages site. You can see the live site at http://fossasia.github.io/open-event-webapp/
The webapp generator used following technologies -
- HTML/CSS/Javascript based frontend
- Node.js /Javascript for the generator backend
- Express.js - Server framework
- Handelbars - Template for rendering
- Socket.io - For handling multi-user client, with progress of upload/generation
Please check the components documentation to learn about the components, and how to change the final outcome of the HTML generated.
You can find documentation and details of various configurations of the server here
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
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
- Once deployed, you'll find the generator running on http://localhost:5000, it should look like this
-
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.
POST /generate
Parameters (x-www-form-urlencoded)
or json
Parameter | Description | Purpose |
---|---|---|
name | (required) Name of the webapp | Unique name of the webapp |
(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 |
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
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 (app/src/test) 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.
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
- Arnav Gupta (@championswimmer)
- Aayush Arora (@aayusharora)
- Mario Behling (@mariobehling)
- Justin Lee (@juslee)