srijanone/opendevportal

OpenDevPortal API Exchange

1.0.1 2021-01-21 12:38 UTC

Requires

• bower-asset/jquery-simple-color: ^1.2.1
• bower-asset/lazysizes: ^5.1
• bower-asset/spectrum: ^1.8.1
• bower-asset/swagger-ui: ^3.25
• composer/installers: ^1.2
• cweagans/composer-patches: ~1.0
• drupal-ckeditor-libraries-group/codesnippet: ^4.5.11
• drupal/address: ^1.8
• drupal/admin_toolbar: ^2.2
• drupal/adminimal_theme: ^1.5
• drupal/advagg: ^4.1
• drupal/allowed_formats: 1.2
• drupal/autologout: ^1.3
• drupal/better_exposed_filters: 4.0-beta1
• drupal/better_normalizers: ^1.0@beta
• drupal/block_classes: ^1.0
• drupal/block_type_templates: ^1.0
• drupal/bootstrap_barrio: ^4.27
• drupal/bootstrap_sass: ^1.11
• drupal/captcha: ^1.1
• drupal/ckeditor_bootstrap_tabs: ^1.1
• drupal/codesnippet: 1.6
• drupal/color_field: ^2.3
• drupal/config_ignore: ^2.2
• drupal/default_content: 1.0-alpha9
• drupal/domain_group: ^1.2
• drupal/ds: ^3.6
• drupal/easy_breadcrumb: ^1.12
• drupal/email_registration: ^1.1
• drupal/entity_browser: ^2.5
• drupal/field_group: 3.0
• drupal/field_permissions: 1.0
• drupal/fivestar: ^1.0
• drupal/group: ^1.2
• drupal/hook_event_dispatcher: ^2.2
• drupal/icon_select: ^1.4
• drupal/jsonapi_extras: ^3.14
• drupal/lazy: ^3.4
• drupal/like_and_dislike: ^1.0
• drupal/markdown: ^1.3
• drupal/menu_per_role: ^1.2
• drupal/menu_token: ^1.0
• drupal/metatag: ^1.13
• drupal/notificationswidget: ^1.5
• drupal/openapi: ^2.0@RC
• drupal/openapi_jsonapi: ^2.0@RC
• drupal/openapi_ui: ^1.0@RC
• drupal/openapi_ui_redoc: ^1.0
• drupal/openapi_ui_swagger: ^1.0@RC
• drupal/paragraphs: 1.11
• drupal/pathauto: ^1.8
• drupal/recaptcha: 3.0
• drupal/redirect: ^1.6
• drupal/redoc_field_formatter: ^1.0
• drupal/restui: ^1.18
• drupal/rules: ^3.0@alpha
• drupal/smtp: ^1.0@RC
• drupal/social_api: 2.0-rc2
• drupal/social_auth_github: ^2.0
• drupal/social_auth_google: ^2.0
• drupal/social_link_field: ^1.1
• drupal/social_media: ^1.8
• drupal/social_media_links: ^2.6
• drupal/subpathauto: ^1.1
• drupal/svg_image: ^1.13
• drupal/swagger_ui_formatter: ^2.4
• drupal/textfield_counter: ^1.11
• drupal/token: ^1.7
• drupal/total_control: 2.0
• drupal/tour_ui: ^1.0
• drupal/userpoints: ^1.0@alpha
• drupal/video_embed_field: 2.4
• drupal/views_aggregator: ^1.0@beta
• drupal/views_autocomplete_filters: 1.3
• drupal/views_bulk_operations: ^3.8
• drush/drush: ^9.2
• league/oauth2-client: ^2.0
• michelf/php-markdown: ^1.9

Conflicts

• drupal/drupal: *

GPL-2.0-or-later

README

OpenDevPortal is a product framework to build custom developer portals. Whether you're a SaaS company looking to publish APIs for App developers or a Financial institution with a sprawling OpenBanking API program, you can use OpenDevPortal to engineer a bespoke developer experience.

Some of OpenDevPortal's most unique features:

• API Program & Product Management with access control
• Fully Customizable Developer Experience & Program Branding
• Connector based architecture (to API gateways & integration systems)
• Developer & Ecosystem Metrics

Use cases

• Manage API Products & Run API programs at scale. Get a unified platform that handles product catalog, program mangement and governance, while ensuring complete program autonomy.

• Provide Best in Class Developer Experience with easy API discovery, curated and interactive documentation and resources, enterprise and community support and more.

• Institutionalize Dev Rel & Developer Marketing. Deliver personalized experiences & contextual recommendations based on a unified 360 degree dev profile, and increase community engagement and developer retention.

• Monetize, Measure & Monitor your API program. Set & track API Product & Program OKRs/KPIs, including revenue, developer engagement & usage goals. Also define rate plans and billing models and integrate with existing billing systems.

Architecture Key Highlights

• One multi-tenant platform to rule it all = Manage multiple API programs & products across multiple gateways under one umbrella
• Plugin based API connector architecture which can be easily extended to create new connectors : Gateways, Billing, Workflow Extensions etc
• Open Source: Build on top of Drupal CMS and supports full Product Management API lifecycle
• Fully customizable UI support via Drupal Layout builder, rich media library, custom themes, text editors etc.
• Any infrastructure: SaaS, PaaS, Public Cloud
• Support for separate HTML or Javascript based frontend utilizing the Portal Management Rest APIs

Installation

Prerequisite

- PHP >= 7.3
- MySQL >= 5.7
- Composer = 1.*

OpenDevPortal utilizes composer to manage its dependencies. So, before using OpenDevPortal, make sure you have Composer installed on your machine.

Installation from source

git clone [e-mail]:srijanone/opendevportal-project.git
cd opendevportal-project
composer install

Installation via Composer Create-Project

• Choose a name for your project, like “MY_PROJECT”
• Use the given command to create the project
• The command will download Drupal core along with necessary modules, OpenDevPortal profile, and all other dependencies necessary for the project

composer create-project srijanone/opendevportal-project:1.0
MY_PROJECT --no-interaction

In case you come across any memory issues, run this command -

php -d memory_limit=-1 /path/to/composer.phar create-project
srijanone/opendevportal-project:1.0 MY_PROJECT --no-interaction

Installation using drush -

time php -d memory_limit=-1 ./vendor/bin/drush si opendevportal  --db-url='mysql://drupal_user:drupal_password@localhost/drupal_db' --site-name='OpenDevPortal' --account-name='Srijan' --account-pass='Admin@123'  --account-mail='[e-mail]' -y

Features

• Multi-tenancy
  • Multiple Developer Program
  • Customisation at Program Level
  • Custom Domain support for each program
• Different shades of Developer Program
  • Public
  • Private
  • Protected
• Productisation of APsI using various features
  • Guides(Pages)
  • Use Cases
  • FAQs
  • Tutorials
  • Downloads
  • Media
  • Blogs
  • Events
  • Solutions
  • Issues
• Product & API Categorisation
• NPS
• Social Sharing
• Tagging Feature
• Multiple view supported for Open API Specifications
  • Rapidoc
  • Swagger
  • Redoc
• Async API Support
• GraphQL Support
• SDK download Support
• User registration with email/Github id/Gmail id
• User Dashboards
• SAML/Github/Gmail login feature supported
• Google Captcha for Authentication
• Forum(For Community Support)
• Issues (Organisational Support)
• Custom Workflows
• Notification(Email & Alerts)
• Search
• Custom pages for branding/marketing
• Custom Connectors

Request for Demo

Contribution

• Explore various features of OpenDevPortal.
• In case of bug please create issue here

Credits

• Srijan Team (https://srijan.net)