Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 4.01 KB

README.md

File metadata and controls

93 lines (59 loc) · 4.01 KB

Open-Event Server

Build Status Dependency Status Codacy Badge Issue Count Test Coverage Coverage Status codecov Gitter

This server which will manage all the data of the event. Backed by a database, it provides API endpoints to fetch the data, and also to modify/update it.

The database can be a sqlite db file or saved in json itself.

The schema for the database is provided here

The data is provided over the API endpoints as described here

Deploy

Communication

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

Getting Started

How do I install Open-Event Server with Docker?:

To install Open-Event Server with Docker please refer to Docker installation

How do I install Open-Event Server with Vagrant?:

For installation steps on how to deploy Open-Event Server using vagrant please refer to Vagrant installation

How to configure Bower? :

In order to install and configure bower please refer to Bower installation

Development Mode

To enable development mode (development Flask config), set APP_CONFIG environment variable to "config.DevelopmentConfig".

export APP_CONFIG=config.DevelopmentConfig

Model updates

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.

##How to run tests for Open-Event Server?: For steps regarding how to run tests please refer to How to run tests

Stack

  • Database - Postgres
  • Webserver - Nginx
  • App server - uwsgi
  • Web framework - flask (particularly flask-admin)

How do I deploy Open-Event Server to Heroku?:

For steps regarding how to deploy your version of the Open-Event Server to Heroku, please refer Heroku deployment

Demo version

Go to demo version

License

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.