You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by sm...@apache.org on 2025/06/21 15:42:02 UTC
(airavata-portals) 01/01: Adding the README
This is an automated email from the ASF dual-hosted git repository.
smarru pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airavata-portals.git
commit 64e1a99b62a92d49de62c42563dc47dcf8ca9e39
Author: Suresh Marru <sm...@apache.org>
AuthorDate: Sat Jun 21 10:42:59 2025 -0400
Adding the README
---
README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ffb6ad7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Apache Airavata Portals
+
+The `airavata-portals` repository is a consolidated home for all web-based user interfaces built on top of the [Apache Airavata](https://airavata.apache.org/) middleware platform. This collection of frontend components and frameworks enables seamless interaction with Airavata's powerful orchestration, identity, data, and compute services.
+
+## Repository Structure
+
+This repository contains the following sub-projects and templates:
+
+### 🖥️ Portals and SDKs
+
+- **airavata-django-portal**
+ The reference web-based user interface for interacting with Airavata services, supporting job submissions, project management, and monitoring.
+
+- **airavata-django-portal-sdk**
+ A pluggable SDK enabling custom Django-based science gateways with minimal setup.
+
+- **airavata-django-portal-commons**
+ Shared UI components and utilities used across Django-based portals.
+
+### Starter Templates
+
+- **airavata-cookiecutter-django-app**
+ Cookiecutter template to scaffold new Django apps for integration with the Django portal.
+
+- **airavata-cookiecutter-django-output-view**
+ Template for building reusable output viewers compatible with portal job results.
+
+### Legacy and Other Frontends
+
+- **airavata-php-gateway**
+ Legacy PHP-based science gateway frontend (archived/deprecated).
+
+- **airavata-custos-portal**
+ Web-based UI for managing Custos identity, group, and resource permissions.
+
+## Purpose
+
+The goal of this consolidation is to:
+
+- Simplify the discovery and contribution process for Airavata frontend components.
+- Encourage reuse of UI components through a shared ecosystem.
+- Promote rapid prototyping and customization of science gateways.
+- Align documentation and tooling across related UI projects.
\ No newline at end of file