Getting Started

In this tutorial, you will setup the Social App Template Example Application that uses Gateway Services. These will all run locally and connect to the public Frequency Testnet. This will give you a quick introduction to a working integration with Gateway Services and a starting place to explore the possibilities.

Expected Time: ~5 minutes

Step 1: Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Git
• Docker
• Node.js
• A Web3 Polkadot wallet (e.g. Polkadot extension)

Step 2: Register on Testnet

To have your application interact on Frequency Testnet, you will need to register as a Provider. This will enable users to delegate to you, and your chain actions to be free via Capacity.

Create an Application Account in a Wallet

• Open a wallet extension such as the Polkadot extension
• Follow account creation steps
• Make sure to keep the seed phrase for the service configuration step

Detailed Instructions

Acquire Testnet Tokens

Visit the Frequency Testnet Faucet and get tokens: Testnet Faucet

Create a Provider

Creating your provider account is easy via the Provider Dashboard.

• Use the same browser with the wallet extension
• Visit the Provider Dashboard
• Select Become a Provider
• Select the Testnet Paseo network
• Connect the Application Account created earlier
• Select Create an MSA and approve the transaction popups
• Choose a public Provider name (e.g. "Cool Test App") and continue via Create Provider
• Stake for Capacity by selecting Stake to Provider and stake 100 XRQCY Tokens

Step 3: Configure and Run the Example

Clone the Example Repository

git clone https://github.com/ProjectLibertyLabs/social-app-template.git

cd social-app-template

Run the Configuration Script

./start.sh

Testnet Setup Help

Use default values when uncertain.

• Do you want to start on Frequency Paseo Testnet? Yes!
• Enter Provider ID This is Provider Id from the Provider Dashboard
• Enter Provider Seed Phrase This is the seed phrase saved from the wallet setup
• Do you want to change the IPFS settings?
  • No if this is just a test run
  • Yes, if you want to use an IPFS pinning service

Step 4: Done & What Happened?

You should now be able to access the Social App Template at http://localhost:3000!

What happened in the background?

All the different services needed were started in Docker (Docker Desktop Screenshot):

Step 5: Shutdown

Stop all the Docker services via the script (with the option to remove saved data), or just use Docker Desktop.

./stop.sh

What's Next?

• Open the OpenAPI/Swagger Documentation for each service
  • Account Service: Local | Public
  • Graph Service: Local | Public
  • Content Publishing Service: Local | Public
  • Content Watcher Service: Local | Public
• Learn about each service
• Read about Running in Production