https://github.com/shazron/adobeio-samples-customers-dashboard

This Firefly app is a complete solution of the codelab Build a Firefly App for Customer Profiles using Adobe Campaign Standard API. It lists customer profiles from Adobe Campaign Standard and allows sending marketing campaign emails with personalized promo code.
https://github.com/shazron/adobeio-samples-customers-dashboard

Last synced: 3 months ago
JSON representation

This Firefly app is a complete solution of the codelab Build a Firefly App for Customer Profiles using Adobe Campaign Standard API. It lists customer profiles from Adobe Campaign Standard and allows sending marketing campaign emails with personalized promo code.

• Host: GitHub
• URL: https://github.com/shazron/adobeio-samples-customers-dashboard
• Owner: shazron
• Fork: true (AdobeDocs/adobeio-samples-customers-dashboard)
• Created: 2021-07-22T14:01:25.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-07-29T13:04:05.000Z (over 3 years ago)
• Last Synced: 2023-04-01T10:57:36.610Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 280 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Firefly Sample App: Customer Profiles Dashboard

This Firefly app is a complete solution of the codelab [Build a Firefly App for Customer Profiles using Adobe Campaign Standard API](https://github.com/AdobeDocs/adobeio-codelabs-campaign-standard). It lists customer profiles from Adobe Campaign Standard and allows sending marketing campaign emails with personalized promo code.

![demo](demo.png)

## Setup

- Populate the `.env` file in the project root and fill it as shown [below](#env). You can also use [dot-env](dot-env) as a template.

## Local Dev

- `aio app run` to start your local Dev server

- App will run on `localhost:9080` by default

By default the UI will be served locally but actions will be deployed and served from Adobe I/O Runtime. To start a

local serverless stack and also run your actions locally use the `aio app run --local` option.

## Test & Coverage

- Run `aio app test` to run unit tests for ui and actions

- Run `aio app test -e` to run e2e tests

## Deploy & Cleanup

- `aio app deploy` to build and deploy all actions on Runtime and static files to CDN

- `aio app undeploy` to undeploy the app

## Config

### `.env`

```bash

# This file should not be committed to source control

## please provide your Adobe I/O Runtime credentials

AIO_RUNTIME_AUTH=

AIO_RUNTIME_NAMESPACE=

## please provide your Adobe I/O Campaign Standard integration parameters

CAMPAIGN_STANDARD_TENANT=

CAMPAIGN_STANDARD_API_KEY=

CAMPAIGN_STANDARD_WORKFLOW_ID=

```

### `package.json`

- We use the `name` and `version` fields for the deployment. Make sure to fill

  those out. Do not use illegal characters as this might break the deployment

  (e.g. `/`, `@`, `#`, ..).

### `manifest.yml`

- List your backend actions under the `actions` field within the `__APP_PACKAGE__`

package placeholder. We will take care of replacing the package name placeholder

by your project name and version.

- For each action, use the `function` field to indicate the path to the action

code.

- More documentation for supported action fields can be found

[here](https://github.com/apache/incubator-openwhisk-wskdeploy/blob/master/specification/html/spec_actions.md#actions).

#### Action Dependencies

- You have two options to resolve your actions' dependencies:

  1. **Packaged action file**: Add your action's dependencies to the root

   `package.json` and install them using `npm install`. Then set the `function`

   field in `manifest.yml` to point to the **entry file** of your action

   folder. We will use `parcelJS` to package your code and dependencies into a

   single minified js file. The action will then be deployed as a single file.

   Use this method if you want to reduce the size of your actions.

  2. **Zipped action folder**: In the folder containing the action code add a

     `package.json` with the action's dependencies. Then set the `function`

     field in `manifest.yml` to point to the **folder** of that action. We will

     install the required dependencies within that directory and zip the folder

     before deploying it as a zipped action. Use this method if you want to keep

     your action's dependencies separated.

## Debugging in VS Code

While running your local server (`aio app run`), both UI and actions can be debugged, to do so open the vscode debugger

and select the debugging configuration called `WebAndActions`.

Alternatively, there are also debug configs for only UI and each separate action.