|
1 | | -# Getting Started |
| 1 | +# Frequency Developer Gateway Guides |
2 | 2 |
|
3 | | -In this tutorial, you will setup the [Social App Template](https://github.com/ProjectLibertyLabs/social-app-template) Example Application that uses Gateway Services. |
4 | | -These will all run locally and connect to the public Frequency Testnet. |
5 | | -This will give you a quick introduction to a working integration with Gateway Services and a starting place to explore the possibilities. |
| 3 | +## Quick Start |
6 | 4 |
|
7 | | -Expected Time: ~5 minutes |
| 5 | +Walk through all the steps to get Gateway and the Social Application Template running in 5 minutes. |
8 | 6 |
|
9 | | -## Step 1: Prerequisites |
| 7 | +<div class="button-links button-links-small"> |
10 | 8 |
|
11 | | -Before you begin, ensure you have the following installed on your machine: |
| 9 | + [Follow the Quick Start Guide](./QuickStart.md) |
12 | 10 |
|
13 | | -- [Git](https://git-scm.com) |
14 | | -- [Docker](https://www.docker.com) |
15 | | -- [Node.js](https://nodejs.org) |
16 | | -- A Web3 Polkadot wallet (_e.g._ [Polkadot extension](https://polkadot.js.org/extension/)) |
| 11 | +</div> |
17 | 12 |
|
18 | | -## Step 2: Register on Testnet |
| 13 | +## Single Sign-On |
19 | 14 |
|
20 | | -To have your application interact on Frequency Testnet, you will need to register as a Provider. |
21 | | -This will enable users to delegate to you, and your chain actions to be free via [Capacity](https://docs.frequency.xyz/Tokenomics/ProviderIncentives.html). |
| 15 | +Learn how to use the Frequency Developer Gateway to quickly add Sign In with Frequency, a single sign-on powered by Frequency, to your application. |
22 | 16 |
|
23 | | -### Create an Application Account in a Wallet |
| 17 | +<div class="button-links button-links-small"> |
24 | 18 |
|
25 | | -- Open a wallet extension such as the [Polkadot extension](https://polkadot.js.org/extension/) |
26 | | -- Follow account creation steps |
27 | | -- _Make sure to keep the seed phrase for the service configuration step_ |
| 19 | + [Follow the SSO Guide](./SSO.md) |
28 | 20 |
|
29 | | -[Detailed Instructions](https://support.polkadot.network/support/solutions/articles/65000098878-how-to-create-a-polkadot-account) |
| 21 | +</div> |
30 | 22 |
|
31 | | -### Acquire Testnet Tokens |
| 23 | +## Become a Provider |
32 | 24 |
|
33 | | -Visit the Frequency Testnet Faucet and get tokens: [Testnet Faucet](https://faucet.testnet.frequency.xyz/) |
| 25 | +Learn how to setup your Provider Account to represent your application on Frequency. |
34 | 26 |
|
35 | | -### Create a Provider |
| 27 | +<div class="button-links button-links-small"> |
36 | 28 |
|
37 | | -Creating your provider account is easy via the [Provider Dashboard](https://provider.frequency.xyz/). |
| 29 | + [Follow the Become a Provider Guide](./BecomeProvider.md) |
38 | 30 |
|
39 | | -- Use the same browser with the wallet extension |
40 | | -- Visit the [Provider Dashboard](https://provider.frequency.xyz/) |
41 | | -- Select `Become a Provider` |
42 | | -- Select the `Testnet Paseo` network |
43 | | -- Connect the Application Account created earlier |
44 | | -- Select `Create an MSA` and approve the transaction popups |
45 | | -- Choose a public Provider name (e.g. "Cool Test App") and continue via `Create Provider` |
46 | | -- Stake for Capacity by selecting `Stake to Provider` and stake 100 XRQCY Tokens |
47 | | - |
48 | | - |
49 | | - |
50 | | -## Step 3: Configure and Run the Example |
51 | | - |
52 | | -### Clone the Example Repository |
53 | | - |
54 | | -```sh |
55 | | -git clone https://github.com/ProjectLibertyLabs/social-app-template.git |
56 | | -``` |
57 | | - |
58 | | -```sh |
59 | | -cd social-app-template |
60 | | -``` |
61 | | - |
62 | | -### Run the Configuration Script |
63 | | - |
64 | | -```sh |
65 | | -./start.sh |
66 | | -``` |
67 | | - |
68 | | -#### Testnet Setup Help |
69 | | - |
70 | | -Use default values when uncertain. |
71 | | - |
72 | | -- `Do you want to start on Frequency Paseo Testnet?` Yes! |
73 | | -- `Enter Provider ID` This is Provider Id from the Provider Dashboard |
74 | | -- `Enter Provider Seed Phrase` This is the seed phrase saved from the wallet setup |
75 | | -- `Do you want to change the IPFS settings?` |
76 | | - - No if this is just a test run |
77 | | - - Yes, if you want to use an [IPFS pinning service](https://docs.ipfs.tech/how-to/work-with-pinning-services/#use-a-third-party-pinning-service) |
78 | | - |
79 | | -## Step 4: Done & What Happened? |
80 | | - |
81 | | -You should now be able to access the Social App Template at [http://localhost:3000](http://localhost:3000)! |
82 | | - |
83 | | - |
84 | | - |
85 | | -### What happened in the background? |
86 | | - |
87 | | -All the different services needed were started in Docker (Docker Desktop Screenshot): |
88 | | - |
89 | | - |
90 | | -## Step 5: Shutdown |
91 | | - |
92 | | -Stop all the Docker services via the script (with the option to remove saved data), or just use Docker Desktop. |
93 | | - |
94 | | -```sh |
95 | | -./stop.sh |
96 | | -``` |
97 | | - |
98 | | -## What's Next? |
99 | | - |
100 | | -- Open the OpenAPI/Swagger Documentation for each service |
101 | | - - Account Service: [Local](http://localhost:3013/docs/swagger) | [Public](https://projectlibertylabs.github.io/gateway/account/) |
102 | | - - Graph Service: [Local](http://localhost:3012/docs/swagger) | [Public](https://projectlibertylabs.github.io/gateway/graph/) |
103 | | - - Content Publishing Service: [Local](http://localhost:3010/docs/swagger) | [Public](https://projectlibertylabs.github.io/gateway/content-publishing/) |
104 | | - - Content Watcher Service: [Local](http://localhost:3011/docs/swagger) | [Public](https://projectlibertylabs.github.io/gateway/content-watcher/) |
105 | | -- [Learn about each service](../Build/) |
106 | | -- [Read about Running in Production](../Run/) |
| 31 | +</div> |
0 commit comments