@sudoplatform/sudo-email-example-js
v4.3.0
Published
Sample app to show Sudo Email JS SDK Capabilities
Downloads
6
Keywords
Readme
Sudo Email JS Sample App
Overview
This project provides examples for interacting with the Sudo Email JS SDK on the Sudo Platform.
Version Support
| Engine | Supported version | | ----------------- | ----------------- | | Node | >= 16 | | Safari | >= 14 | | Firefox | last 2 versions | | Chromium and Edge | last 2 versions | | IE | not supported |
Getting Started
To run this sample app you must first add a TEST registration key and SDK configuration file to the project.
Follow the steps in the Getting Started guide and in User Registration to obtain a config file (sudoplatformconfig.json) and a TEST registration key, respectively.
Place both files in the following location with these names:
[project-root]/config/sudoplatformconfig.json
[project-root]/config/register_key.private
- Create a text file named
register_key.id
containing the TEST registration key ID in the same location:
[project-root]/config/register_key.id
Launching the app
- Follow the above steps in "Getting Started".
yarn install --frozen-lockfile && yarn start
- Navigate to
http://localhost:3000
in your browser.
Building Assets
- Clone this repository
yarn install --frozen-lockfile && yarn build
- Assets will be built into the
dist
folder.
More Documentation
Refer to the following documents for more information:
Issues and Support
File issues you find with this sample app in this Github repository. Ensure that you do not include any Personally Identifiable Information (PII), API keys, custom endpoints, etc. when reporting an issue.
For general questions about the Sudo Platform please contact [email protected]