Google Git
Sign in
apache / airavata-custos-portal / cddc1bfb33bec81460b3a79c6bc7935ef0c932e4
commitcddc1bfb33bec81460b3a79c6bc7935ef0c932e4[log] [tgz]
authorMarcus Christie <machristie@apache.org>Wed May 03 09:26:54 2023 -0400
committerGitHub <noreply@github.com>Wed May 03 09:26:54 2023 -0400
tree6afe291ed3c90d63735f93829b28a605a99dd3c1
parentdd7ba079d5ce4a9233d910511a4cf2bf228c89b3 [diff]
parente3c9d8d49eafff1717b3ea615ce8efc89ad1e37f [diff]
Merge pull request #176 from apache/local-custos-integration-fixes

Fixes for running the Custos portal against a local Custos deployment
tree: 6afe291ed3c90d63735f93829b28a605a99dd3c1
  1. airavata_custos_portal/
  2. public/
  3. src/
  4. .dockerignore
  5. .env
  6. .gitignore
  7. .nvmrc
  8. 1
  9. babel.config.js
  10. docker-compose.yml
  11. Dockerfile
  12. entrypoint.sh
  13. LICENSE
  14. manage.py
  15. nginx.conf
  16. package.json
  17. README.md
  18. requirements.txt
  19. setup.cfg
  20. setup.py
  21. vue.config.js
  22. yarn-error.log
  23. yarn.lock
README.md

Airavata Custos Portal

Getting started with running locally

.env file

Assuming you are running Custos locally (see https://github.com/apache/airavata-custos/tree/develop#quickstart), edit the .env file to match the client id and secret generated by the Custos bootstrap service:

CUSTOS_CLIENT_ID="custos-s8qf9g3odbbcdsgd2khv-10000000"
CUSTOS_CLIENT_SEC="..."
CUSTOS_API_URL="http://localhost:10000"
CUSTOS_SUPER_CLIENT_ID="custos-s8qf9g3odbbcdsgd2khv-10000000"

Running the frontend

You need Node.js 14 and Yarn 1 installed.

yarn install
yarn run serve

Running the Django server

You need Python 3.9+.

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
./manage.py migrate
./manage.py runserver

How to use as a Django app

Airavat custos portal is available as a python package to install and customise for tenants needs. The forllowing instructions are for setting up a customised portal using all the features available in the airavata custos portal.

  1. Install
pip install airavata-custos-portal
  1. Create a Django app
django-admin startproject my_first_custos_app .
cd my_first_custos_app
django-admin startapp apps
cd apps
django-admin startapp frontend
  1. Include the custos portal api and frontend in the urls.
# my_first_custos_app/apps/frontend/urls.py

from django.contrib import admin
from django.urls import path
from django.conf.urls import include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("api/", include("airavata_custos_portal.apps.api.urls")),
    path("", include("airavata_custos_portal.apps.frontend.urls")),
]
  1. Also, include the custom UI app in the urls.
# my_first_custos_app/apps/frontend/urls.py

from django.contrib import admin
from django.urls import path
from django.conf.urls import include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("api/", include("airavata_custos_portal.apps.api.urls")),
    path("", include("airavata_custos_portal.apps.frontend.urls")),
    path("custom-ui/", include("my_first_custos_app.my_custom_ui.urls")),
]

Development

The application consists of a Vue.js frontend and a Django based backend. The instructions below are for setting up the local setup for development.

Change the configurations

Change the environment variables on .env

Run Vue.js app

yarn install
yarn serve

Lints and fixes files

yarn lint

Running the Django server locally

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
./manage.py migrate
./manage.py runserver

And then point to http://localhost:8000

How to publish

  1. Build the static files
yarn build
  1. Build the python package
python -m pip install --upgrade build
python -m build
  1. Publish the python package to pypi.org. Optionally can push to test.pypi.org. See https://packaging.python.org/tutorials/packaging-projects/ for more info.
python -m pip install --upgrade twine
python -m twine upload dist/*