commit | e3c9d8d49eafff1717b3ea615ce8efc89ad1e37f | [log] [tgz] |
---|---|---|
author | Marcus Christie <machristie@apache.org> | Wed May 03 09:17:39 2023 -0400 |
committer | Marcus Christie <machristie@apache.org> | Wed May 03 09:17:39 2023 -0400 |
tree | 6afe291ed3c90d63735f93829b28a605a99dd3c1 | |
parent | 3f86396e275d4c0bcd759f996066187fdd78399e [diff] |
Updated README with quickstart instructions for working with Custos local development
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"
You need Node.js 14 and Yarn 1 installed.
yarn install yarn run serve
You need Python 3.9+.
python -m venv venv source venv/bin/activate pip install -r requirements.txt ./manage.py migrate ./manage.py runserver
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.
pip install airavata-custos-portal
django-admin startproject my_first_custos_app . cd my_first_custos_app django-admin startapp apps cd apps django-admin startapp frontend
# 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")), ]
# 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")), ]
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 environment variables on .env
yarn install yarn serve
yarn lint
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
yarn build
python -m pip install --upgrade build python -m build
python -m pip install --upgrade twine python -m twine upload dist/*