The Open Event API Server enables organizers to manage events from concerts to conferences and meet-ups. It offers features for events with several tracks and venues. Event managers can create invitation forms for speakers and build schedules in a drag and drop interface. The event information is stored in a database. 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 JSON and binary media files like images and audio.
The Open Event API Server exposes a well documented JSON:API Spec Compliant REST API that can be used by external services (like the Open Event App generators and the frontend) to access & manipulate the data.
API Documentation:
- Every installation of the project includes API docs, (e.g. here on the test install https://open-event-api.herokuapp.com).
- A hosted version of the API docs is available in the
gh-pagesbranch of the repository at http://dev.eventyay.com/api/v1
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: gitter.im/fossasia/open-event-orga-server
A demo version is automatically deployed from our repositories:
- Deployment from the
nextgenbranch - open-event-api.herokuapp.com - Deployment from the
masterbranch - open-event.herokuapp.com - Deployment from the
developmentbranch - open-event-dev.herokuapp.com - Developer documentation
gh-pages- dev.eventyay.com
The Open Event API Server can be easily deployed on a variety of platforms. Detailed platform specific installation instructions have been provided below.
- Generic Installation Instructions
- Local Installation
- Vagrant Installation
- Deployment on Google Compute Engine
- Deployment on Google Container Engine (Kubernetes)
- Deployment on AWS EC2
- Deployment on Digital Ocean
- Deployment with Docker
- Deployment on Heroku
The docs are outdated and will be updated for the nextgen version soon
One-click Heroku deployment is also available:
Please get familiar with the components of the project in order to be able to contribute.
- Database - PostgreSQL
- Web framework - Flask
- App server - uWSGI
- Web Server - NGINX
OAuth is used to get information from Facebook and Google accounts, that enables users to sign in with their respective credentials:
- Google - https://accounts.google.com/o/oauth2/auth
- Facebook - https://graph.facebook.com/oauth
Twitter feed integration is provided in the public event pages.
Required keys can be obtained from https://dev.twitter.com/overview/documentation
It is possible to extend the functionality and offer images from Instagram in the event service.
Required keys can be obtained from https://www.instagram.com/developer/authentication/.
Google maps is used to get information about location (info about country, city, latitude and longitude).
Required keys can be obtained from https://maps.googleapis.com/maps/api.
Media (like audio, avatars and logos) can be stored either Locally or on Amazon S3 or on Google Storage.
The server can send emails via SMTP or using the sendgrid API.
- SMTP can be configured directly at
admin/settings - Obtaining Sendgrid API Token.
If the application is deployed on Heroku, we use the heroku API to obtain the latest release and also to display the heroku.
Required token can be obtained from https://devcenter.heroku.com/articles/authentication.
For ticket sales the service integrates payment gateways:
- Stripe - Obtaining Keys.
- Paypal - Obtaining Credentials.
Import:
Open Event API server supports multiple formats as a valid source for import.
- A zip archive with JSON (matching the API structure) and binary media files. Read more about this here.
- The Pentabarf XML format is also supported as a valid import source. (Sample file).
Export:
The event data and the sessions can be exported in various formats.
- A zip archive with JSON (matching the API structure) and binary media files. Read more about this here.
- The Pentabarf XML format. (Sample file).
- The iCal format. (Sample file).
- The xCal format. (Sample file).
The system has two kind of role type.
- System roles are related to the Open Event organization and operator of the application.
- Event Roles are related to the users of the system with their different permissions.
Read more here.
To enable development mode (development Flask config), set APP_CONFIG environment variable to "config.DevelopmentConfig".
export APP_CONFIG=config.DevelopmentConfig
When writing changes to models. Use migrations.
# To generate a migration after doing a model update
python manage.py db migrate
# To sync Database
python manage.py db upgrade
# To rollback
python manage.py db downgrade
When checking in code for models, please update migrations as well.
Clone the repo and set up the server according to the steps listed. Make sure you have installed are the dependencies required for testing by running
pip install -r requirements/tests.txt
- Open Event uses Postgres database for testing. So set
DATABASE_URLas a postgres database. Here is an example.
export DATABASE_URL=postgresql://test_user:test@127.0.0.1:5432/opev_test
# format is postgresql://USERNAME:PASSWORD@ADDRESS/DATABASE_NAME
export APP_CONFIG=config.TestingConfig- Then go to the project directory and run the following command:
python -m unittest discover tests/unittests/
-
It will run each test one by one.
-
You can also use the following command to run tests using nosetests:
nosetests tests/unittests/
- Make sure you have FireFox installed
- Start your local flask server instance.
- Go to the project directory and Run the tests by using the following command.
robot -v SERVER:{server_name} -v SUPERUSER_USERNAME:{super_user_email_here} -v SUPERUSER_PASSWORD:{super_user_password} tests/robot
Change all the parameters inside {} as per your local server. The final command would look like:
robot -v SERVER:localhost:5000 -v SUPERUSER_USERNAME:test@opev.net -v SUPERUSER_PASSWORD:test_password tests/robot
- Once the tests are completed, a report and a log would be generated at
report.htmlandlog.htmlrespectively in your root directory.
Certain information is being logged and stored in the database for future reference, resolving conflicts in case of hacks and for maintaining an overview of the system. Read more about logging here.
Open Event is being translated using Weblate, a web tool designed to ease translating for both developers and translators.
If you would like to contribute to translation of Open Event, you need to register on this server.
Once you have activated your account just proceed to the translation section.
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-orga-server/issues
We have the following branches
- development All development goes on in this branch. If you're making a contribution, please make a pull request to development. PRs to must pass a build check and a unit-test check on Travis (https://open-event-dev.herokuapp.com - Is running off the development branch. It is hosted on Heroku.)
- master This contains shipped code. After significant features/bug-fixes are accumulated on development, we make a version update, and make a release. (https://eventyay.com - Is running off the master branch. (whichever is the latest release.) Hosted on Google Cloud Platform (Google Container Engine + Kubernetes).)
- nextgen
All development for the
nextgenversion of the Open Event Orga Server (aka Open Event API Server) goes on in this branch. If you're making a contribution, please make a pull request to nextgen. PRs to must pass a build check and a unit-test check on Travis (https://open-event-api.herokuapp.com - Is running off thenextgenbranch. It is hosted on Heroku.) (https://api.eventyay.com - Is running off thenextgenbranch. Hosted on Google Cloud Platform (Google Container Engine + Kubernetes).) - gh-pages This contains the documentation website on http://dev.eventyay.com. The site is build automatically on each commit in the development branch through a script and using travis. It includes the md files of the Readme and /docs folder. It also includes javadocs.
The tentative release policy for now is, (since there is a lot of activity and a lot of bugs), an alpha release every monday and friday (since we see more activity on weekends). So, any bug-fixes will not be reflected at eventyay.com until a new release is made in the master branch.
Commits
- Write clear meaningful git commit messages (Do read http://chris.beams.io/posts/git-commit/)
- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests )
- When you make very very minor changes to a PR of yours (like for example fixing a failing travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git )
- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
Feature Requests and Bug Reports
- When you file a feature request or when you are submitting a bug report to the issue tracker, make sure you add steps to reproduce it. Especially if that bug is some weird/rare one.
Join the development
- Before you join development, please set up the system on your local machine and go through the application completely. Press on any link/button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring 😉 Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
- Test the application on your machine and explore the admin area. The test deployment on Heroku will not give you access to the admin section, where you can switch on/off modules, e.g. ticketing and add keys for services, e.g. storage on S3.
- If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.
This project is currently licensed under the GNU General Public License v3. A copy of LICENSE.md should be present along with the source code. To obtain the software under a different license, please contact FOSSASIA.