Apache Airavata Django Portal

Clone this repo:
  1. ee4071d AIRAVATA-2934 Docs on starting custom django app, next steps by Marcus Christie · 5 days ago master
  2. 099a33e AIRAVATA-3260 fixed table layout by Marcus Christie · 5 weeks ago
  3. ba7c70f AIRAVATA-3277 Dispatch valid/invalid whenever valid changes by Marcus Christie · 5 weeks ago
  4. 8c88a56 Ignore sqlite3 dbs by Marcus Christie · 5 weeks ago
  5. 8377d77 Disable source maps for production js builds by Marcus Christie · 6 weeks ago

Apache Airavata Django Portal

Build Status Build Status

The Airavata Django Portal is a web interface to the Apache Airavata API implemented using the Django web framework. The intention is that the Airavata Django Portal can be used as is for a full featured web based science gateway but it can also be customized through various plugins to add more domain specific functionality as needed.

Getting Started

The following steps will help you quickly get started with running the Airavata Django Portal locally. This will allow you to try it out and can also be used as a development environment. If you just want to run the Airavata Django Portal locally, see the Docker instructions below for a more simplified approach.

The Airavata Django Portal is developed with Python 3.6 but should also work with 3.4 and 3.5. You'll need one of these versions installed locally.

You'll also need Node.js and yarn to build the JavaScript frontend code. Please install the most recent LTS version of Node.js and the Yarn package manager.

  1. Checkout this project and create a virtual environment.

    git clone https://github.com/apache/airavata-django-portal.git
    cd airavata-django-portal
    python3 -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt
    • macOS note: to install the MySQL dependencies you need to have the MySQL development headers and libraries installed. Also, on macOS you need to have openssl installed. See the mysqlclient-python installation notes for more details.
  2. Create a local settings file. Copy django_airavata/settings_local.py.sample to django_airavata/settings_local.py and edit the contents to match your Keycloak and Airavata server deployments.

    cp django_airavata/settings_local.py.sample django_airavata/settings_local.py
  3. Run Django migrations

    python manage.py migrate
  4. Build the JavaScript sources. There are a few JavaScript packages in the source tree, colocated with the Django apps in which they are used. The build_js.sh script will build them all.

  5. Load the default Wagtail CMS pages.

    python manage.py load_default_gateway
  6. Run the server

    python manage.py runserver
    • Note: if you want to use OpenID Connect authentication from the Django Portal when running it locally, you'll need to first set the following environment to allow OAuth over insecure HTTP:

  7. Point your browser to http://localhost:8000.

Docker instructions

To run the Django Portal as a Docker container, you need a settings_local.py file which you can create from the settings_local.py.sample file. Then run the following:

  1. Build the Docker image.

    docker build -t airavata-django-portal .
  2. Run the Docker container.

    docker run -d \
      -v $PWD/django_airavata/settings_local.py.sample:/code/django_airavata/settings_local.py \
      -p 8000:8000 airavata-django-portal

    But instead of $PWD/django_airavata/settings_local.py.sample you can substitute your own settings_local.py file.

  3. Point your browser to http://localhost:8000.


Documentation currently is available at https://apache-airavata-django-portal.readthedocs.io/en/latest/ (built from the ‘docs’ directory).

To build the documentation locally, first set up a development environment, then run the following in the root of the project:

mkdocs serve


Please send feedback to the mailing list at dev@airavata.apache.org. If you encounter bugs or would like to request a new feature you can do so in the Airavata Jira project (just select the Django Portal component when you make your issue).


For general information on how to contribute, please see the Get Involved section of the Apache Airavata website.

Setting up development environment

Run pip install -r requirements-dev.txt to install development and testing libraries.

Use a code editor that integrates with editorconfig and flake8. I also recommend autopep8 for automatically formatting code to follow the PEP8 guidelines.


The Apache Airavata Django Portal is licensed under the Apache 2.0 license. For more information see the LICENSE file.