developer-portal
Reactive icon

Developer Portal

Stable version 1.2.3 (Compatible with OutSystems 11)
Uploaded
 on 19 December 2024
 by 
0.0
 (0 ratings)
developer-portal

Developer Portal

Documentation
1.2.3

Enabling Service Center SSO

Single Sign-On Between App Types is required for this application

  1. Turn on 'Single Sign-On Between App Types' in Service Center

    • Navigate to the Service Center settings.
    • Enable the option labeled 'Single Sign-On Between App Types'.
      • If this option is disabled, proceed to step 2.
  2. Enable HTTP Strict Transport Security (HSTS) and Secure Cookies in Lifetime

    • Go to the Lifetime environment.
    • Enable the following settings:
      • HTTP Strict Transport Security (HSTS)
      • Secure Cookies
  3. Apply Settings and Re-login

    • After applying the changes, log out of Service Center.
    • Log back in and verify that the Single Sign-On (SSO) is now enabled.

Site Properties

The following site properties can be used to toggle features in the Developer Portal:

  1. FeatureFlag_ShowDevActivity (default: False): Show the developer activity chart in the profile page.
  2. FeatureFlag_ShowDevPublishHistory (default: False): Show the developer publish history count in the profile page.

Javascript Libraries Dependencies

  1. Apache Echarts v5.5.1 https://github.com/apache/echarts 
  2. Luxon v3.4.4 https://github.com/moment/luxon/ 
  3. Tippy.js v6.3.7 https://github.com/atomiks/tippyjs 
  4. SimpleMDE v1.11.2 https://github.com/sparksuite/simplemde-markdown-editor 

Cypress Testing Suite

I have created an end-to-end (e2e) test using Cypress to capture screenshots for this Forge component. This test suite can be useful for anyone who wants to experiment with Cypress or understand how to implement automated testing for their applications. You can find the test suite here: https://github.com/izambasiron/DeveloperPortal-Test 

Installation

  1. Clone the repository:

    git clone https://github.com/izambasiron/DeveloperPortal-Test 

  2. Navigate to the project directory:

    cd DeveloperPortal-Test 

  3. Install the dependencies:

    npm install

Environment Variables

  1. Rename .env.example to .env.
  2. Open the .env file and set the following variables:
    • BASE_URL: The URL of the Developer Portal you want to test.
    • CYPRESS_APP_DIR: The directory where the Developer Portal is located.
    • CYPRESS_USERNAME: The username for the test account.
    • CYPRESS_PASSWORD: The password for the test account.

Usage

To run the Cypress tests, you can use the following scripts:

  • cy:open: Opens the Cypress Test Runner.

      npm run cy:open

  • cy:env:open: Opens the Cypress Test Runner with environment variables from .env file.

      npm run cy:env:open

Security Best Practices

  • Use a dedicated automated test account: Ensure that the username and password used for testing belong to a dedicated test account with limited permissions. This account should not have access to sensitive data or administrative functions.
  • Do not commit .env files to version control: Add .env to your .gitignore file to prevent it from being committed to your repository.
  • Rotate credentials regularly: Change the test account credentials periodically to minimize the risk of unauthorized access.

1.2.1

Enabling Service Center SSO

Single Sign-On Between App Types is required for this application

  1. Turn on 'Single Sign-On Between App Types' in Service Center

    • Navigate to the Service Center settings.
    • Enable the option labeled 'Single Sign-On Between App Types'.
      • If this option is disabled, proceed to step 2.
  2. Enable HTTP Strict Transport Security (HSTS) and Secure Cookies in Lifetime

    • Go to the Lifetime environment.
    • Enable the following settings:
      • HTTP Strict Transport Security (HSTS)
      • Secure Cookies
  3. Apply Settings and Re-login

    • After applying the changes, log out of Service Center.
    • Log back in and verify that the Single Sign-On (SSO) is now enabled.

Site Properties

The following site properties can be used to toggle features in the Developer Portal:

  1. FeatureFlag_ShowDevActivity (default: False): Show the developer activity chart in the profile page.
  2. FeatureFlag_ShowDevPublishHistory (default: False): Show the developer publish history count in the profile page.

Javascript Libraries Dependencies

  1. Apache Echarts v5.5.1 https://github.com/apache/echarts 
  2. Luxon v3.4.4 https://github.com/moment/luxon/ 
  3. Tippy.js v6.3.7 https://github.com/atomiks/tippyjs 
  4. SimpleMDE v1.11.2 https://github.com/sparksuite/simplemde-markdown-editor 

Cypress Testing Suite

I have created an end-to-end (e2e) test using Cypress to capture screenshots for this Forge component. This test suite can be useful for anyone who wants to experiment with Cypress or understand how to implement automated testing for their applications. You can find the test suite here: https://github.com/izambasiron/DeveloperPortal-Test 

Installation

  1. Clone the repository:

    git clone https://github.com/izambasiron/DeveloperPortal-Test 

  2. Navigate to the project directory:

    cd DeveloperPortal-Test 

  3. Install the dependencies:

    npm install

Environment Variables

  1. Rename .env.example to .env.
  2. Open the .env file and set the following variables:
    • BASE_URL: The URL of the Developer Portal you want to test.
    • CYPRESS_APP_DIR: The directory where the Developer Portal is located.
    • CYPRESS_USERNAME: The username for the test account.
    • CYPRESS_PASSWORD: The password for the test account.

Usage

To run the Cypress tests, you can use the following scripts:

  • cy:open: Opens the Cypress Test Runner.

      npm run cy:open

  • cy:env:open: Opens the Cypress Test Runner with environment variables from .env file.

      npm run cy:env:open

Security Best Practices

  • Use a dedicated automated test account: Ensure that the username and password used for testing belong to a dedicated test account with limited permissions. This account should not have access to sensitive data or administrative functions.
  • Do not commit .env files to version control: Add .env to your .gitignore file to prevent it from being committed to your repository.
  • Rotate credentials regularly: Change the test account credentials periodically to minimize the risk of unauthorized access.

1.2.0

Enabling Service Center SSO

Single Sign-On Between App Types is required for this application

  1. Turn on 'Single Sign-On Between App Types' in Service Center

    • Navigate to the Service Center settings.
    • Enable the option labeled 'Single Sign-On Between App Types'.
      • If this option is disabled, proceed to step 2.
  2. Enable HTTP Strict Transport Security (HSTS) and Secure Cookies in Lifetime

    • Go to the Lifetime environment.
    • Enable the following settings:
      • HTTP Strict Transport Security (HSTS)
      • Secure Cookies
  3. Apply Settings and Re-login

    • After applying the changes, log out of Service Center.
    • Log back in and verify that the Single Sign-On (SSO) is now enabled.

Site Properties

The following site properties can be used to toggle features in the Developer Portal:

  1. FeatureFlag_ShowDevActivity (default: False): Show the developer activity chart in the profile page.
  2. FeatureFlag_ShowDevPublishHistory (default: False): Show the developer publish history count in the profile page.

Javascript Libraries Dependencies

  1. Apache Echarts v5.5.1 https://github.com/apache/echarts 
  2. Luxon v3.4.4 https://github.com/moment/luxon/ 
  3. Tippy.js v6.3.7 https://github.com/atomiks/tippyjs 
  4. SimpleMDE v1.11.2 https://github.com/sparksuite/simplemde-markdown-editor 

Cypress Testing Suite

I have created an end-to-end (e2e) test using Cypress to capture screenshots for this Forge component. This test suite can be useful for anyone who wants to experiment with Cypress or understand how to implement automated testing for their applications. You can find the test suite here: https://github.com/izambasiron/DeveloperPortal-Test 

Installation

  1. Clone the repository:

    git clone https://github.com/izambasiron/DeveloperPortal-Test 

  2. Navigate to the project directory:

    cd DeveloperPortal-Test 

  3. Install the dependencies:

    npm install

Environment Variables

  1. Rename .env.example to .env.
  2. Open the .env file and set the following variables:
    • BASE_URL: The URL of the Developer Portal you want to test.
    • CYPRESS_APP_DIR: The directory where the Developer Portal is located.
    • CYPRESS_USERNAME: The username for the test account.
    • CYPRESS_PASSWORD: The password for the test account.

Usage

To run the Cypress tests, you can use the following scripts:

  • cy:open: Opens the Cypress Test Runner.

      npm run cy:open

  • cy:env:open: Opens the Cypress Test Runner with environment variables from .env file.

      npm run cy:env:open

Security Best Practices

  • Use a dedicated automated test account: Ensure that the username and password used for testing belong to a dedicated test account with limited permissions. This account should not have access to sensitive data or administrative functions.
  • Do not commit .env files to version control: Add .env to your .gitignore file to prevent it from being committed to your repository.
  • Rotate credentials regularly: Change the test account credentials periodically to minimize the risk of unauthorized access.