srijanone/ezdevportal

EzDevPortal API Exchange

Maintainers

Details

github.com/srijanone/ezdevportal

Homepage

Source

Issues

Installs: 135

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 2

Type:drupal-profile

2.0.2 2023-10-10 11:04 UTC

Requires

  • bower-asset/swagger-ui: ^4.15
  • drupal/address: ^1.12
  • drupal/admin_toolbar: ^3.4
  • drupal/adminimal_theme: ^1.7
  • drupal/advagg: ^6.0@alpha
  • drupal/autologout: ^1.4
  • drupal/better_exposed_filters: ^6.0
  • drupal/better_normalizers: dev-3286221-8.x-1.x-automated-drupal-10
  • drupal/blog: ^3.1
  • drupal/bootstrap_barrio: ^5.5
  • drupal/charts: ^5.0
  • drupal/color: ^1.0
  • drupal/color_field: ^3.0
  • drupal/components: ^3.0@beta
  • drupal/config_ignore: ^2.4
  • drupal/custom_breadcrumbs: ^1.x-dev@dev
  • drupal/default_content: ^2.0
  • drupal/easy_breadcrumb: ^2.0
  • drupal/email_registration: ^1.2
  • drupal/entity_browser: ^2.9
  • drupal/field_group: ^3.4
  • drupal/field_permissions: ^1.2
  • drupal/google_analytics: ^4.0
  • drupal/google_analytics_reports: ^4.0@alpha
  • drupal/icon_select: ^3.0@beta
  • drupal/jquery_ui_touch_punch: ^1.1
  • drupal/layout_builder_modal: ^1.2
  • drupal/layout_custom_section_classes: ^1.0
  • drupal/like_and_dislike: ^1.0@beta
  • drupal/markdown: ^3.0@RC
  • drupal/menu_item_role_access: ^2.1
  • drupal/menu_token: ^9.1.x-dev@dev
  • drupal/metatag: ^2.0
  • drupal/notificationswidget: ^1.8
  • drupal/paragraphs: ^1.15
  • drupal/pathauto: ^1.11
  • drupal/r4032login: ^2.2
  • drupal/recaptcha: ^3.2
  • drupal/redirect: ^1.8
  • drupal/redoc_field_formatter: ^3.0
  • drupal/simple_popup_blocks: ^3.1
  • drupal/slick: ^2.9
  • drupal/social_api: ^4.0
  • drupal/social_auth_github: ^4.0
  • drupal/social_auth_google: ^4.0
  • drupal/social_media: ^2.0
  • drupal/social_media_links: ^2.9
  • drupal/svg_image: ^3.0
  • drupal/swagger_ui_formatter: ^4.0
  • drupal/user_menu_avatar: ^9.0
  • drupal/video_embed_field: ^2.5
  • drupal/views_block_filter_block: ^2.0
  • drupal/views_bootstrap: ^4.4
  • drupal/views_bulk_operations: ^4.2
  • drupal/views_infinite_scroll: ^2.0
  • drupal/webform: ^6.2@beta
  • drush/drush: ^12.1
  • league/commonmark: ^1.0
  • npm-asset/jquery-ui-touch-punch: ^0.2.3

Requires (Dev)

Conflicts

GPL-2.0-or-later f90ae3ee74a21ba7be43facb6833170e1775403f

This package is auto-updated.

Last update: 2024-04-30 00:33:05 UTC

README

  • About EzDevPortal
  • Features
  • Architectural Highlights
  • Drupal 9 Installation
  • Credits

About EzDevPortal

EzDevPortal is a Drupal install profile for setting up fully customizable developer portal. 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 EzDevPortal to engineer a bespoke developer experience.

Features

Key Features

  • Product & API Categorization:

    Organize APIs and products that have similar attributes into categories and catalogs for quick navigation and discoverability.

  • Self-service Capabilities:

    Comes with custom workflows that streamlines admin processes like content & access control and simplifies the onboarding process for both upstream and downstream user journeys.

  • Analytics:

    Integrate with Google Analytics to track and view reports like session information, top pages, keywords etc. In addition, app analytics like API usage can be tracked*.

  • Custom APIM Connectors:

    Through preconfigured connectors, integrate the developer portal with your APIMs, to manage access requests for your developers and much more.

  • API Documentation:

    Supports generating API documentation from multiple languages including OAS (swagger), Rapidoc, and code snippets.

  • Enhanced Site Search:

    Advanced search capabilities to facilitate browsing and searching in API catalogs.

  • SDK download Support:

    Auto generate client-side SDKs to create apps that can consume subscribed APIs.

  • Content Management:

    Build API ecosystem by creating and managing pages, blogs, media, use cases, forums and FAQs.

Detailed Features List

  • Productization of APIs using various features
    • Guides(Pages)
    • Use Cases
    • FAQs
    • Tutorials
    • Media
    • Blogs
  • Product categorization
  • Social Sharing
  • Multiple view supported for Open API Specifications
    • Rapidoc
    • Swagger
    • Redoc
  • Async API Support
  • GraphQL Support
  • SDK download support
  • User registration/login with email/Github/Gmail
  • User Dashboard
  • Forum(For Community Support)
  • Issues (Organisational Support)
  • Notification(Email & Alerts)
  • Search
  • Siteadmin functionality for content management
  • Custom pages creation for branding/marketing
  • Optional demo content for quickstart
  • Pluggable Connectors to various API gateways like Apigee, Kong, AWS Api Gateway, Azure API Gateway

Architectural Highlights

  • Open Source: Built 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.
  • Plugin based API connector architecture which can be easily extended to create new connectors.
  • Hosting on any infrastructure: PaaS, Public Cloud
  • Support for separate HTML or Javascript based frontend utilizing the Portal Management Rest APIs

Drupal 9 Installation

Prerequisites

- PHP >= 8.0
- MariaDB 10.3.7+
- MySQL 5.7.8+
- Composer = 2.*

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

Installation from source

git clone git@github.com:srijanone/ezdevportal-project.git
cd ezdevportal-project
composer install

Installation via composer

  • 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, EzDevPortal profile, and all other dependencies necessary for the project
composer create-project srijanone/ezdevportal-project
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/ezdevportal-project MY_PROJECT --no-interaction

You can install the site either through drush or using GUI method.

Drush method

Navigate to the project root through terminal and execute the following command:

./vendor/bin/drush si ezdevportal
--db-url='mysql://{mysql_user}:{mysql_password}@{mysql_host}/{db_name}'
--site-name='EzDevPortal' --account-name='Srijan'
--account-pass='Admin@123'  --account-mail='admin@example.com' -y

GUI Method

Setup a local environment using either docker(ddev, lando etc.) or LAMP stack.

Run the normal drupal GUI installation process. You can choose to install the demo module during installion or you can install it later from extend page or using drush.

Clear the drupal cache after installing the demo module.

Credits