Skip to content

Latest commit

 

History

History
175 lines (98 loc) · 6.42 KB

README.md

File metadata and controls

175 lines (98 loc) · 6.42 KB

Description

This DApp uses moralis server, DB and functions (LiveQuery and Cloud Function) to subscribe to onchain events from a contract deployed to Polygon, BSC and Kovan networks in real time. When a user pings the front end, the react DApp will increment the count and show the latest ping information.

Hosted Live on Vercel: https://react-moralis-livequery-ping.vercel.app/

Watch the Video Demo: https://www.youtube.com/watch?v=5Gp4XPR-YW8

image

This is a Next.js project bootstrapped with create-next-app.

Framework

Requirements:

Node js.

Moralis Account

Metamask Wallet => NB: USE A FRESH WALLET WITH NO REAL VALUABLE ASSETS ON IT (test only).

Technically not a dependency - you can use remix to make and deploy your contracts Truffle => install using npm command. Remix => browser based contract development & deployment

npm install -g truffle

Contracts: Truffle, Solidity, Moralis, Metamask

Front-end: React, Next (routing, SSR)

Other npm libs: @react-moralis, @truffle/hdwallet-provider, dotenv, semantic-ui-react

Running the App

  1. Clone the repo git clone https://github.com/DeveloperAlly/react-moralis-livequery-ping.git
  2. Install dependencies npm install
  3. Create a Moralis server see here for more help
  4. (OPTIONAL) Deploy the contracts either through remix or using truffle truffle migrate --network kovan, truffle migrate --network bsc, truffle migrate --network polygon. OR use the contract addresses found in .env.example to try this out
  5. Create a .env file > touch .env
  6. Add the moralis details & the smart contract deployed addresses to the .env file (as per the .env.example file)
  7. Create a moralis sync event on your server with details needed (example shown below - abi can be found in /pages/api/contracts/syncABI.json)
  8. Create a moralis Cloud Function (code can be found in /pages/api/cloudFunctions/FetchInitialData.js)
  9. Run the front end from your terminal locally >npm run dev
  10. Navigate to http://localhost:3000 to see the app in action!

Step 8: Find the code in /pages/api/contracts/syncABI.json syncEventExample image

Step 9: Find the code in /pages/api/cloudFunctions/FetchInitialData.js image

Architecture diagrams

Components Architecture diagram

Authorisation / Web3 Logon Authorisation

BugList / To-do List

Probably some around here... but is it a bug or an undocumented feature??? Just kidding - submit an issue or PR :P

Resources

Moralis: https://moralis.io

React-moralis: https://github.com/MoralisWeb3/react-moralis

Moralis YouTube: https://www.youtube.com/channel/UCgWS9Q3P5AxCWyQLT2kQhBw

Moralis Forum: https://forum.moralis.io/

Faucets for testnets

Polygon: https://faucet.polygon.technology/

BSC testnet: https://testnet.binance.org/faucet-smart (check out bnb faucet - it basically uses liveQuery to show most recent addresses that have requested funds!)

Kovan Eth: https://kovan.chain.link/

Handy links for chainIds:

https://chainlist.org/

Docs for used framework

Moralis Docs: https://docs.moralis.io/ Discord: Forum: https://forum.moralis.io/ Moralis npm: https://www.npmjs.com/package/moralis React-moralis: https://www.npmjs.com/package/react-moralis & https://github.com/MoralisWeb3/react-moralis & https://docs.moralis.io/moralis-server/tools/react-moralis YouTube: https://www.youtube.com/channel/UCgWS9Q3P5AxCWyQLT2kQhBw

Solidity lang https://docs.soliditylang.org/

Nextjs (not needed - have not really used the features that make next cool so you could just use a react app) https://nextjs.org/docs

React https://reactjs.org/docs

Truffle https://www.trufflesuite.com/ React Semantic-ui (I prefer material-ui though) https://react.semantic-ui.com/

React-moralis

Metamask https://docs.metamask.io/

Remix (for testing contracts initially) http://remix.ethereum.org/

Block explorer links

Mumbai polygon: https://mumbai.polygonscan.com/

Kovan eth: https://kovan.etherscan.io/

BSC testnet: https://testnet.bscscan.com/

Nextjs DOCS - Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.