This is an automated email from the ASF dual-hosted git repository. smarru pushed a commit to branch develop in repository https://gitbox.apache.org/repos/asf/airavata-custos-portal.git
commit bf0f51c6b167185fb411c9158781ed11e15c1e88 Author: Shivam Rastogi <shivam_r...@yahoo.com> AuthorDate: Sat Apr 18 15:04:14 2020 -0400 Updated readme --- README | 3 --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 3 deletions(-) diff --git a/README b/README deleted file mode 100644 index 2f43c32..0000000 --- a/README +++ /dev/null @@ -1,3 +0,0 @@ -# Apache Airavata Custos Portal - -Portal interface implemented in Django Framework to use and administer Custos Services \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..122ab1a --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Apache Airavata Custos Portal + +Portal interface implemented in Django Framework to use and administer Custos Services. + + +#### Run instructions + +1. Create a python virtual env for custos portal +``` +python -m venv venv +``` +2. Install dependencies using +``` +pip install -r requirements.txt +``` +3. Install custos client SDK in the virtual env (Follow instructions in "Install Custos Client SDK") +4. Run django server using manage.py file in custos_portal directory. +``` +python manage.py runserver +``` +5. Run webpack development server from custos_portal/custos_portal/static/common using: +``` +npm run serve +``` + + +#### Install Custos Client SDK +1. Create install files for custos client SDK using [README](https://github.com/apache/airavata-custos/tree/develop/custos-client-sdks/custos-python-sdk) +2. Install the zip files created in the dist folder after activating the virtual environment created for custos portal. +``` +pip install custos-python-sdk-1.0.0.tar.gz +``` + + +#### Architecture #### +This Django projects consists of 3 apps +- Admin: Handles all the requests and screens related to admin users in the portal +- Auth: Handles user registeration, login, passwords, login using institutional accounts +- Workspace: Handles all the requests for a regular users like 'create new tenant requests' + +We also use vuejs for the screens in Admin and Workspace folders. The components and other javascript files can be found +at ```custos_portal\static\common``` \ No newline at end of file