Install & Configure

How to install

The installation is done via direct plugin upload. You can check this article for a tutorial on how to do it.

Download the latest version (1.10.4) of our plugin: Download

Plugin activation

On plugin activation the following things are done:

  • Default pages are created for:
    • Sign-in on the URI /fans-united-signin (Shortcode: [fans-united-firebase-signin-with-email])
    • Registration on the URI /fans-united-register (Shortcode: [fans-united-firebase-registration])
    • Forgotten password on the URI /fans-united-forgotten-password (Shortcode: [fans-united-firebase-forgotten-password])
    • Profile on the URI /fans-united-profile (Shortcode: [fans-united-profile-content])
  • Settings page in the admin panel for you to manage your Fans United integration
  • Labels page in the admin panel for you to manage the Fans United related labels on your website
  • Fans United gutenberg blocks are created that allow you to use Fans United functionality in any page or article.

πŸ“˜

The default pages display shortcodes

The default pages created on activation contain the functionality within something called Shortcodes. This means that if you want to have, for example, the profile page on a different URL, you can create a new page, display the profile via its shortcode and delete the default page.

🚧

Default pages are deleted on plugin deactivation

All the pages created on the plugin activation are deleted when it's been deactivated. Keep that in mind in case you want to enrich the content on the default pages.

πŸ“˜

Settings and Labels are persisted

The settings and labels you enter in the WP admin panel will persist even after the plugin deactivation. This is done on purpose, so that the plugin is easier to set up on re-install and upgrade.

If you want the settings removed, please delete the values first and then deactivate the plugin.

How to configure?

Once the plugin is installed and activated, a settings page will appear:

WordPress Admin > Settings > Fans United

Here you will find settings for Fans United platform, as well as for your authentication service (Firebase).

The labels can be found here:

WordPress Admin > Settings > Fans United Labels

Mandatory fields

There are 2 mandatory fields in the Fans United Configuration section:

  • Fans United Client ID: The ID for your project, provided by the Fans United team.
  • Fans United API Key: The API key issued to you for access to the platform.

The other options default to a fallback value.

For the authentication with Firebase Authentication, you will need to provide the following mandatory fields:

  • Firebase API Key
  • Firebase Auth Domain
  • Firebase Project ID
  • Firebase Application ID

All these can be found in:

Your Firebase Console > Project settings > Your Apps > Add App

What happens after the configuration is done?

After the configuration is done, your Fans United integration is active and working. Your users will be able to register and sign in their profiles, add interests, play games, etc.

How do I upgrade to a new version?

If you have the Fans United plugin already installed and you want to upgrade to the latest version, you need to:

  1. Deactivate the current version of the plugin in the WordPress dashboard.
  2. Delete the old version.
  3. Click on 'Add New' under the plugins menu, then 'Upload Plugin' at the top, and upload the new .zip file
  4. Activate the newly uploaded version.
  5. Configure any new features that are available with the newer version (old settings are preserved).

If you don't want to manually update the plugin, you can always use a third-party plugin that can automate the manual update process for you, such as the "Easy Theme and Plugin Upgrades" plugin. Using this plugin you can just upload the new version. It will back-up your current version and update to the latest version of the Fans United plugin.


What’s Next

See the supported blocks in WordPress