https://github.com/superfaceai/example-glitch-email

Glitch example showcasing email failover on SendEmail use case
https://github.com/superfaceai/example-glitch-email

geocoding glitch superface

Last synced: about 1 month ago
JSON representation

Glitch example showcasing email failover on SendEmail use case

• Host: GitHub
• URL: https://github.com/superfaceai/example-glitch-email
• Owner: superfaceai
• Created: 2021-07-01T09:18:45.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-24T13:36:35.000Z (over 3 years ago)
• Last Synced: 2024-05-28T20:06:19.886Z (7 months ago)
• Topics: geocoding, glitch, superface
• Language: JavaScript
• Homepage: https://superface-email.glitch.me
• Size: 284 KB
• Stars: 0
• Watchers: 10
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Email Example

This project showcases the use of  to seamlessly integrate APIs and handle provider's failover without worrying about how they are implemented or even knowing what API and therefore provider do you use.

## Application

The demo application allows you to choose from 3 use cases, either classic email use case, fetch the names of repositores for a specified GitHub or Gitlab user or fetch the address for a specified coordinates and send these fetched information to the email entered in form.

To see how to fetch the repositories or send email using Superface's [OneSDK](https://github.com/superfaceai/one-sdk-js) check out the `fetchUserRepos()` and `sendEmail()` fuctions in the `superface.js` file.

## What's in this project?

← `superface.js`: This file contains all superface code except superface client code, which is centralized in `client.js`. It contains functions like `fetchUserRepos()` where profile and provider are set and result from perform is handled

← `client.js`: This file contains centralized Superface client and function to get it

← `hooks.js`: This file contains settings of event hooks for centralized client, they're used to trigger fake failover on `pre-fetch`. It also contains functions to get information about failover.

← `public/`, `src/`: Folders from the remixed Glitch Node.js starter project, it is safe to ignore those for the puprose of learning about Superface

← `server.js`: The main server script of the application, it does not contain Superface-specific code, only a boiler plate to make the application work

← `superface/`: Superface folder that contains the configuration of the [OneSDK](https://github.com/superfaceai/one-sdk-js) for the capabilities and providers used in the application

← `superface/super.json`: The actual configuration of the capabilties and providers

← `.env`: Secrets such as API keys for the used providers

## More Examples

[Geocode Example](https://glitch.com/edit/#!/superface-geocode) - use Superface to get coordinates from address

[Reverse Geocode Example](https://glitch.com/edit/#!/reverse-geocode-superface) - use Superface to get address from coordinates

## Get in touch

We would ❤️ to hear your feedback! Please get in touch either with Vrata ([email protected]) or Z ([email protected]).

If you haven't already, sign up at [https://superface.ai](https://superface.ai).

You can also follow us at Twitter [@superfaceai](https://twitter.com/superfaceai).