ethyaan / tribe-crypto-widget

Tribe Crypto ShortCode Widget

A set of shortcodes to add crypto currencies information into your post or comment
Explore the docs »

Build Apps · Expert Network

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. License

About The Project

This Project adds this feature to tribe platform posts & replys to support defined crypto currency shortcodes which will be replaced with realtime market data.

example usage of the available shortcodes:
[cw top-10] will return the top 10 based on coinmarketcap ranking

[cw top-10 pair="TRY"] will return the top 10 based on coinmarketcap ranking with TRY instead of USD as second side of the pair

[cw list="BNB,SOL,ADA"] will return the info about given list of currencies

[cw list="BTC,ETH,ADA" pair="EUR"] will return the info about given list of currencies with EUR instead of USD as second side of the pair

Note: default value for pair is USD

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Make sure you install the node and mongodb

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Create your app at partners.tribe.so
2. Clone the repo

   git clone https://github.com/tribeplatform/tribe-starter-app

3. Install NPM packages

   npm install

4. Create your .env file by duplicating .env.example

   cp.env.example.env;

5. Add the credentials of your app, database, etc in the .env

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)