8000 GitHub - hdahme/CoralProtocolSampleApp · GitHub
[go: up one dir, main page]

Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

10 Commits

Folders and files

Repository files navigation

Coral Protocol Sample App

This app serves as an example of how to integrate Coral Protocol into your application. There are examples of how to get Trust Scores, set Trust Score Alerts, and consume those alerts.

Coral's Trust Score Alerts allow someone to subscribe to changes in an Ethereum or Bitcoin address' trust score.

Trust Score Alerts operate as webhooks, where the documentation can be found at docs.heycoral.com.

This repository serves as a sample app that you can clone and use. From there you can write your own (or contribute! 😊) integrations. Twilio and Slack integrations are provided as examples.

Setup

npm install ngrok -g

npm install

Copy env.dist to .env and fill it with your own secrets. Most notably, you will need to use your Coral API key.

Development

We use ngrok to expose this application to the internet, so Coral's API can reach it. Start the app with npm start and expose it in a separate temrinal with ngrok $PORT

Production

This app is also accompanied by a Docker file so you can run it wherever you run your production code 😎

Creating Alerts.

Please review our documentation for more information on how to create an alert.

Contribution

If you write a cool integration, please contribute it back to this sample app so that others may also stay compliant! One I personally would like to see is PagerDuty.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0