You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by ma...@apache.org on 2023/05/03 13:21:36 UTC
[airavata-custos-portal] branch local-custos-integration-fixes created (now e3c9d8d)
This is an automated email from the ASF dual-hosted git repository.
machristie pushed a change to branch local-custos-integration-fixes
in repository https://gitbox.apache.org/repos/asf/airavata-custos-portal.git
at e3c9d8d Updated README with quickstart instructions for working with Custos local development
This branch includes the following new commits:
new 2a51327 Run dev server on port 9002 since local Custos docker containers take ports 9000 and 9001
new 3f86396 Downgrade PyJWT, newer one has incompatible method signature
new e3c9d8d Updated README with quickstart instructions for working with Custos local development
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[airavata-custos-portal] 03/03: Updated README with quickstart instructions for working with Custos local development
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
machristie pushed a commit to branch local-custos-integration-fixes
in repository https://gitbox.apache.org/repos/asf/airavata-custos-portal.git
commit e3c9d8d49eafff1717b3ea615ce8efc89ad1e37f
Author: Marcus Christie <ma...@apache.org>
AuthorDate: Wed May 3 09:17:39 2023 -0400
Updated README with quickstart instructions for working with Custos local development
---
README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++----------
1 file changed, 50 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index b0c4e20..b9fb426 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,56 @@
# Airavata Custos Portal
-## How to use
+## Getting started with running locally
-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.
+### .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
```
2. Create a Django app
+
```
django-admin startproject my_first_custos_app .
cd my_first_custos_app
@@ -23,7 +62,7 @@ django-admin startapp frontend
3. Include the custos portal api and frontend in the urls.
```
-# my_first_custos_app/apps/frontend/urls.py
+# my_first_custos_app/apps/frontend/urls.py
from django.contrib import admin
from django.urls import path
@@ -39,7 +78,7 @@ urlpatterns = [
4. Also, include the custom UI app in the urls.
```
-# my_first_custos_app/apps/frontend/urls.py
+# my_first_custos_app/apps/frontend/urls.py
from django.contrib import admin
from django.urls import path
@@ -55,8 +94,8 @@ urlpatterns = [
## 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.
+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
@@ -81,7 +120,6 @@ yarn lint
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
-cd airavata_custos_portal/
./manage.py migrate
./manage.py runserver
```
@@ -91,6 +129,7 @@ And then point to http://localhost:8000
## How to publish
1. Build the static files
+
```
yarn build
```
@@ -102,7 +141,8 @@ python -m pip install --upgrade build
python -m build
```
-3. 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.
+3. 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
[airavata-custos-portal] 01/03: Run dev server on port 9002 since local Custos docker containers take ports 9000 and 9001
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
machristie pushed a commit to branch local-custos-integration-fixes
in repository https://gitbox.apache.org/repos/asf/airavata-custos-portal.git
commit 2a51327c9612d6908f335b0e4c80afaeba8d2b9d
Author: Marcus Christie <ma...@apache.org>
AuthorDate: Tue May 2 16:57:21 2023 -0400
Run dev server on port 9002 since local Custos docker containers take ports 9000 and 9001
---
vue.config.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/vue.config.js b/vue.config.js
index 376881d..83fe34d 100644
--- a/vue.config.js
+++ b/vue.config.js
@@ -1,5 +1,5 @@
const BundleTracker = require("webpack-bundle-tracker");
-const port = 9000;
+const port = 9002;
module.exports = {
publicPath:
[airavata-custos-portal] 02/03: Downgrade PyJWT, newer one has incompatible method signature
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
machristie pushed a commit to branch local-custos-integration-fixes
in repository https://gitbox.apache.org/repos/asf/airavata-custos-portal.git
commit 3f86396e275d4c0bcd759f996066187fdd78399e
Author: Marcus Christie <ma...@apache.org>
AuthorDate: Tue May 2 16:58:05 2023 -0400
Downgrade PyJWT, newer one has incompatible method signature
---
requirements.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements.txt b/requirements.txt
index 17bf72f..1e7dc69 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -27,7 +27,7 @@ prompt-toolkit==3.0.32
ptyprocess==0.7.0
pure-eval==0.2.2
Pygments==2.13.0
-PyJWT==2.6.0
+PyJWT==0.4.3
pytz==2022.6
requests==2.28.2
six==1.16.0