iangsalmon / ezra-sample-app Goto Github PK

The Ezra Sample Application is a full simple application for React/Redux, demonstrating the use of Cloud Elements APIs in a UI. The primary goal is to demonstrate the use of the unified provisioning service (Ezra) to connect various integrations with ease.

Keep in mind that Cloud Elements is a server-side API library, production applications should not store keys or make API calls directly from client-side code. This project is merely a source of sample code intended as a tool for gaining familiarity with the Cloud Elements APIs in a user-facing example. If you're interested in a version of this app that contains additional functionality, please file an issue.

• Responsive
• Simplified integration provisioning (Ezra)
• Material UI styling
• Router/Redux/React included
• Docker container for production build

Before running this demo application of standardized auth, you will need to make a single API call to get an application id that you can then pass in to your environment variables (.env or .env.local file).

To do this, make a POST request to the following URL with the below request body and headers https://{environment}.cloud-elements.com/v1alpha1/elements/normalized-instances/applications.

Request Body:

{
    "appProvidedElAgnosticMetadata": true,
    "appProvidedElSpecificMetadata": true,
    "notificationCallback": {
        "url": "https://ce-demo-app.free.beeceptor.com"
    },
    "description": "DemoApp",
    "includeCETagline": true,
    "name": "Unified authentication"
}

Request Headers:

'Authorization: User {userToken}, Organization {organizationToken}'
'Content-Type: application/json'
'Accept : application/json'

Notes:

• Make sure you choose an environment (staging, snapshot, or production) and pass it into the above URL.
• Make sure your User and Organization secrets are from the environment you choose.

Example cUrl:

curl --location --request POST 'https://staging.cloud-elements.com/v1alpha1/elements/normalized-instances/applications' \
--header 'Authorization: User ----, Organization ----' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appProvidedElAgnosticMetadata": true,
    "appProvidedElSpecificMetadata": true,
    "notificationCallback": {
        "url": "https://ce-demo-app.free.beeceptor.com"
    },
    "description": "DemoApp",
    "includeCETagline": true,
    "name": "Unified authentication"
}'

Response Body:

{
    "applicationID": "123456abc-defg-123a-bcd5-edf8142324fc",
    "name": "Unified authentication",
    "description": "DemoApp",
    "appProvidedElementSpecificConfig": false,
    "appProvidedElementAgnosticConfig": false,
    "identityID": "75f3deea-613d-4dbd-b17c-16cedc3ef176",
    "createdDate": "2021-01-12 12:45:57",
    "updatedDate": "2021-01-12 12:45:57",
    "notificationCallback": {
        "url": "https://ce-demo-app.free.beeceptor.com",
        "format": "json",
        "token": "FGVOK0FV51dW2BUN3xWb"
    },
    "branding": {
        "headerFontColor": "",
        "headerFontType": "",
        "logo": "",
        "backgroundColor": "",
        "formLabelFontColor": "",
        "formLabelFontType": "",
        "formInputFontType": "",
        "formInputBorderColor": "",
        "formInputBorderRadius": "",
        "formInputBackgroundColor": "",
        "formInputPasswordIconColor": "",
        "radioFieldColor": "",
        "dropdownFieldFontType": "",
        "dropdownFieldBorderColor": "",
        "dropdownFieldBorderRadius": "",
        "dropdownFieldBackgroundColor": "",
        "buttonBorderColor": "",
        "buttonBorderRadius": "",
        "buttonBackgroundColor": "",
        "buttonFontType": "",
        "buttonFontColor": "",
        "optionalGuidanceMessageFontType": "",
        "optionalGuidanceMessageFontColor": "",
        "disclaimerFontType": "",
        "disclaimerFontColor": "",
        "linkFontType": "",
        "linkFontColor": "",
        "errorMessageBackgroundColor": "",
        "errorMessageFontColor": "",
        "errorMessageFontType": "",
        "includeCETaglineLink": false,
        "linkOne": {
            "text": "",
            "link": ""
        },
        "linkTwo": {
            "text": "",
            "link": ""
        },
        "linkThree": {
            "text": "",
            "link": ""
        }
    }
}

• Make sure to grab the applicationID from the response body of your POST request.

This application requires an envirionment file to run. The environment file contains desired environment, application IDs, and OAuth keys that are referenced throughout the project in the interest of keeping it easily adjustable. A sample environment file has been provided for you in .env. However, you can create a local environment file to override it:

 $ touch .env.local

Add your Cloud Elements keys to the .env.local file:

## Cloud Elements keys/environment
REACT_APP_CE_USER={your-cloud-elements-user-token}
REACT_APP_CE_ORG={your-cloud-elements-org-token}
REACT_APP_CE_ENV=[optional for using staging or snapshot, app defaults to production]

The user and org tokens can be found on Cloud Elements UI, in the user profile popout on the bottom left. For example: https://my-snapshot.cloudelements.io/welcome

Add your vendor OAuth app keys to the .env.local file. Only one set is needed for the app to function, but the total number is unlimited. These keys are utilized in the LoginCardList component.

Note: Your vendor OAuth application should have the Ezra callback URL registered, ie one of: https://provisioning.snapshot.us.cloudelements.io/callback, https://provisioning.staging.us.cloudelements.io/callback, or https://provisioning.production.us.cloudelements.io/callback. You will add this callback URL as a redirect uri when you create a vendor app.

## Vendor App keys
REACT_APP_HUBSPOT_KEY={your-hubspot-oauth-app-key}
REACT_APP_HUBSPOT_SECRET={your-hubspot-oauth-app-secret}

Add the applicationID from the response body you received when creating your application (prerequisite step above).

# Provisioning service application ID
REACT_APP_EZRA_APP_ID={your-applicationID}

Now you are ready to run the app!

Skip any dependencies and just run the following to get started:

$ docker-compose -f deploy/docker-compose.yaml up --build

If you don't have node and npm installed, do that first.

The project was developed on node version v10.20.1 and npm version 6.14.4. However, node version >= 8 and npm version >= 4.1.2 should suffice.

Navigate into the project directory and install package dependencies.

# Make sure you are in the correct directory
$ cd ezra-sample-app

# Install all necessary npm packages:
$ npm install
# or
$ yarn install

$ docker-compose -f deploy/docker-compose.yaml up --build

# Fire that bad boy up:
$ yarn start
# or
$ npm start

This project was bootstrapped with Create React App.

In the project directory, you can run:

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!