Code Monkey home page Code Monkey logo

nexus's Introduction

Celo

Nexus

Table of Contents
  1. About The Project
  2. Usage
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. 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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.