/nexus

MiniPay project for external partners

Primary LanguageTypeScriptMIT LicenseMIT

Celo

Nexus

Table of Contents
  1. About The Project
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Nexus allows you to quickly build, deploy, and iterate on SocialConnect inside MiniPay.

(back to top)

Built With

Nexus is built on Celo to make it simple to test SocialConnect features inside MiniPay site tester.

(back to top)

Prerequisites

  • Node (v18)

How to use Nexus

Clone the repo

git clone https://github.com/celo-org/nexus.git

Install the packages

yarn

Setup Environment Variables

All the following variables go in the /packages/react-app/.env.local file (you can create a copy from .env.local.example)

Get WalletConnect Project ID

Sign up for WalletConnect and get the project id.

WalletConnect Project id

Setup Issuer and Issuer DEK

The steps to setup issuer and issuer DEK are here.

Environment

You can use either MAINNET or TESTNET as the values for NEXT_PUBLIC_ENVIRONMENT, depending on which the RPC and Contract Addresses change.

Run the project

You can use the following command to run the project locally.

yarn dev

This will start the app at http://localhost:3000.

Since, this app is running on localhost and cannot be opened in MiniPay we need to create a tunnel we will use ngrok for the same.

  1. Create an account on ngrok, setup ngrok on your machine.

    [!NOTE] ngrok is offering free static domain, use that so the url of the app does not change!

  2. Use the following command, to start the tunnel.

    If you have the static domain

    ngrok http --domain=<STATIC_DOMAIN> 3000

    If not

    ngrok http 3000

How to test your DApp in MiniPay

  1. Open the MiniPay app on your phone and click on compass icon.

    minipay-app

  2. Click on "Test Page" to open the MiniPay test page.

    minipay-apps-screen

  3. Enter the URL of your DApp and click on "Go".

    minipay-site-tester

Support

Team at Celo keeps a constant eye on issues, so please open an issue here and also feel free to introduce yourself, share progress and engage with other MiniPay partners and the Celo team here in discussions.

License

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

Contact

(back to top)