Crypto Portfolio Tracker

WordPress plugin Documentation

About

Crypto Portfolio Tracker is a plugin, which allows your website visitors to create and track their own cryptocurrency portfolios.

System requirements

  • WordPress 3.x or higher
  • PHP 5.6.0 or higher

Setup

Firebase

The plugin uses Google Firebase to store user portfolios and optionally authenticate users. Please follow these steps to set up a Firebase application:

  1. Log in to your Google account and open Firebase console.
  2. Click Add project.
  3. Enter the project name (e.g. My Portfolio Tracking App).
  4. Click Continue to save the project.
  5. Click the cog icon next to Project Overview and select Project settings.
  6. You should see this message: There are no apps in your project. Click </> button next to this message to create a web app.
  7. Choose app name and click Register the app.
  8. After the app is created you will be provided with some configuration code. Select firebaseConfig configuration object with your mouse as displayed below and copy it (you will need it later):
  9. Click Authentication in the main menu and open Sign-in method tab. Find Anonymous provider in the table and click on it to enable. If you wish to use authentication with email and password then you also need to enable Email/Password provider.
  10. Click Database in the main menu and then click Create database. Choose Start in locked mode and click Enable.
  11. Open Rules tab, replace the editor content with the following and then click Publish:
    {
      "rules": {
        "users": {
          "$uid": {
            "portfolios": {
              ".read": "$uid == auth.uid",
              ".write": "$uid == auth.uid",
              "$pid": {
                ".read": "$uid == auth.uid || root.child('shared-portfolios/' + $pid).exists()",
                ".write": "$uid == auth.uid"
              }
            },
            "transactions": {
              "$pid": {
                ".read": "$uid == auth.uid || root.child('shared-portfolios/' + $pid).exists()",
                ".write": "$uid == auth.uid"
              }
            }
          }
        },
        "shared-portfolios": {
          "$pid": {
            ".read": true,
            ".write": "data.val() == null && newData.val() == auth.uid || data.val() == auth.uid && newData.val() == null"
          }
        }
      }
    }
                            
    You should see a message that rules are successfully published.

CryptoCompare API

The plugin pulls cryptocurrencies market data from CryptoCompare API. Sign up with CryptoCompare and obtain a FREE API key.

Plugin installation

  • Download the plugin zip archive from CodeCanyon.
  • Log in to WordPress admin area and select Plugins » Add New in the main menu.
  • Click Upload plugin button.
  • Select the downloaded plugin zip archive.
  • Click Install now button.
  • After the plugin is installed click Activate button.
  • Click Crypto Portfolio Tracker in the main menu to open the plugin settings page.
  • Input Firebase and Cryptocompare API settings and click Save.
  • Insert [crypto_portfolio_tracker] shortcode to a page or post where you want the Crypto Portfolio Tracker app to load.

Frequently Asked Questions

What is Firebase authentication for?

Firebase authentication allows the plugin to identify users of the Crypto Portfolio Tracker plugin - either explicitly or implicitly. This is required for mapping stored user portfolios to specific user accounts, so that when a user visits your website again portfolios that the user created earlier can be loaded from the realtime database.

When Firebase authentication is enabled users will be required to log in or sign up before creating any portfolios. Please note that this authentication is different from the native WordPress authentication, so even if user is logged in to your WordPress website separate authentication against Firebase will still be required.

When Firebase authentication is disabled users will be automatically authenticated using anonymous accounts when first accessing the app. Their sessions will be stored in a browser and remain active until browser cache / local data is cleared.

You can manage all users accounts by going to Firebase console, choosing your Firebase app and clicking Authentication in the main menu.

How to customize the password reset email template?

In the Firebase console click Authentication in the main menu and then switch to Templates tab. Choose Password Reset from the list of templates and customize it as needed.

How to translate text strings into my native language?

The plugin is WPML compatible, which means that you can use any WordPress translation plugin (such as Loco Translate for instance) to translate text strings from English into any other language.

How to upgrade the plugin?

  • Download the plugin zip archive from CodeCanyon.
  • Log in to WordPress admin area and select Plugins » Installed Plugins in the main menu.
  • Find Crypto Portfolio Tracker in the list of plugins, click Deactivate and then Delete.
  • Install the new version of the plugin as if was the first time (note that the plugin settings will be preserved).

How do I get support?

In case of any issues or questions please submit a support ticket at https://support.financialplugins.com.