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.
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.
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.
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
Create a local settings file. Copy
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
Run Django migrations
python manage.py migrate
build_js.sh script will build them all.
Load the default Wagtail CMS pages.
python manage.py load_default_gateway
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:
``` export OAUTHLIB_INSECURE_TRANSPORT=1 ```
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:
Please send feedback to the mailing list at firstname.lastname@example.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.
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.