The Open Event Orga 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 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.
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-orga-server
A demo version is automatically deployed from our repositories:
Please check out the documentation here.
A step-by-step guide on how to run Orga Server on a system locally can be found in Installations document
For installation steps on how to deploy Open-Event Server using vagrant please refer to Vagrant installation
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.
To install Open-Event Server with Docker please refer to Docker installation
For steps regarding how to deploy your version of the Open Event Server to Heroku, please refer Heroku deployment or use the one button deployment.
Orga Server requires Redis to run Celery which runs the background tasks in the application.
To setup Redis in your system, use the run_redis.sh script. It will download and build redis in the project's folder.
Also if Redis has been already downloaded, it won't download it again.
bash run_redis.shTo start the redis server, run the following command while at project's root directory.
redis-3.2.1/src/redis-serverYou can use ampersand (&) at the end of the above command if you want to start redis server as daemon (i.e. in background).
redis-3.2.1/src/redis-server &If you want to use a different Redis server than the above, then you can provide the server url in REDIS_URL environment variable.
The default value for REDIS_URL is redis://localhost:6379/0 which is the same as that of local Redis server.
Please get familiar with the components of the project in order to be able to contribute.
- Database - Postgres
- Webserver - Nginx
- App server - uwsgi
- Web framework - flask (particularly flask-admin)
OAuth is used to get information from Facebook and Google accounts, that enables users to sign in with their respective credentials:
The server integrates twitter on event pages. To obtain the required keys visit: https://dev.twitter.com/overview/documentation
It is possible to extend the functionality and offer images from Instagram in the event service. To obtain required keys visit: https://www.instagram.com/developer/authentication/
We are using on Google maps to get information about location (info about country, city, latitude and longitude) https://maps.googleapis.com/maps/api/ We use it to get current location and display closes events.
We are storing audio, avatars and logos either on local storage or Amazon S3. Read more about the set up of Amazon S3 here
To send emails we are using sendgrid https://api.sendgrid.com/api/mail.send.json
We use heroku releases to see which version is deployed https://api.heroku.com/apps/open-event/releases and we also use Github to get info about commit (for example: commit message, author name) at https://api.github.com/repos/fossasia/open-event-orga-server/commits
For ticket sales the service integrates payment gateways:
- Stripe
- Paypal
Every installation of the project includes the API docs with Swagger, e.g. here on the test install http://open-event-dev.herokuapp.com/api/v2/ .
A hosted version of the API docs is available in the gh-pages branch of the repository at https://fossasia.github.io/open-event-orga-server/api/v2/
The data of events is provided over API endpoints as described here
It is also possible to export or import data matching the API structure as a compressed file with JSON and binary media files. Read more about this here.
The system has two kind of role type. 1. System roles are related to the Open Event organization and operator of the application. 2. Event Roles are related to the users of the system with their different permissions. Read more here.
We use Bower to manage front-end dependencies. cd to the directory where bower.json is stored and run:
-
First we have to install npm and nodejs. Run the following:
sudo apt-get install npm -
Then run the following command to get Bower:
sudo npm install -g bower -
Finally run the following command to install the dependencies from bower.json:
bower install
Note: If you are working from within a proxied network of an organization/institute, Bower might not be able to install the libraries. For that, we need to configure .bowerrc to work via proxy.
- Open .bowerrc in any text editor like vim. Run:
vim .bowerrc - The contents of .bowerrc will be something like this:
{
"directory": "app/static/admin/lib"
}
- Modify the file to add "proxy" and "https-proxy" properties like this:
{
"directory": "app/static/admin/lib",
"proxy": "http://172.31.1.23:8080",
"https-proxy": "http://172.31.1.23:8080"
}
- Save and exit. Now we can run
bower installto install our libraries.
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.
First install 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
- Next 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.htmlrepectively 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 loggin here.
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, you are supposed to make a pull request to development. PRs to master must pass a build check and a unit-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.
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.