Merge pull request #176 from apache/local-custos-integration-fixes
Fixes for running the Custos portal against a local Custos deployment
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 @@
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 @@
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 @@
## 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 @@
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 @@
## How to publish
1. Build the static files
+
```
yarn build
```
@@ -102,7 +141,8 @@
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
diff --git a/requirements.txt b/requirements.txt
index 17bf72f..1e7dc69 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -27,7 +27,7 @@
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
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:
