Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/astralprotocol/geonft-registry-poc
Monorepo with a hardhat contract and dapp
https://github.com/astralprotocol/geonft-registry-poc
Last synced: 7 days ago
JSON representation
Monorepo with a hardhat contract and dapp
- Host: GitHub
- URL: https://github.com/astralprotocol/geonft-registry-poc
- Owner: AstralProtocol
- License: mit
- Created: 2022-02-09T14:09:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-10T05:15:08.000Z (about 1 year ago)
- Last Synced: 2024-04-23T13:39:07.836Z (7 months ago)
- Language: TypeScript
- Homepage: https://kolektivo-geonft-poc.on.fleek.co/
- Size: 1.71 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# GeoNFT and Spatial Data Registry Proof-of-Concept
Monorepo with two packages:
- hardhat-ts: a hardhat typescript project
- runs and deploys the NFT contracts to a local node
- deploys contract to Alfajores testnet
- deploys contract to Celo mainnet
- dapp: a React, Redux web application
- allows anyone to mint a GeoNFT
- IPFS for metadata
- adds a Ceramic document
## TODO
- dapp
- Add wallet mock to expand testing in Jest
## Requirements
Yarn
## Install
```bash
git clone https://github.com/AstralProtocol/geonft-registry-poc.git
cd geonft-registry-poc
yarn install
```
### Setup .env file for dapp
Create an Infura Account and an Infura project with IPFS Service, copy `packages/dapp/.env.sample` to `packages/dapp/.env` and fill in the following fields:
REACT_APP_PROJECT_ID=
REACT_APP_PROJECT_SECRET=
### Setup Metamask
To run locally, create a new profile in Chrome and open the Metamask plugin.
Import the test seed phrase: `test test test test test test test test test test test junk`
Under `Networks` click `Show/hide test networks`
Open Metamask `Settings`, `Networks`, and select `Localhost 8545`. Set chainId to `31337`
Select `Localhost 8545` network.
Notice: when running a Localhost node, you may receive this error: `Nonce too high. Expected nonce to be 1 but got N. Note that transactions can't be queued when automining.` As a fix, go to `Settings`, `Advanced`, and click `Reset Account`.
## Run
### Hardhat Local Node
Open a terminal and run `yarn hardhat:localnode`
### Run dapp
Open packages/dapp/webpack.config.js and update devServer...host with your local IP Address.
Open a second terminal and run `yarn dapp:start`
Open your Chrome profile with test Metamask instance and go to
### Wallet
1) Select Metamask and connect with the localhost node.
2) Select WalletConnect and scan the QR Code with your Alfajores wallet.
## Available Scripts
In the project directory, you can run:
### dapp
#### `yarn dapp:start`
Runs the app in development mode on
#### `yarn dapp:test`
Runs the React test watcher in an interactive mode.
By default, runs tests related to files changed since the last commit.
[Read more about testing React.](https://facebook.github.io/create-react-app/docs/running-tests)
#### `yarn dapp:webpack`
Builds the dapp for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
### hardhat-ts
#### `yarn hardhat:test`
Run the tests in the test directory
#### `yarn hardhat:watch`
Starts a local node, deploys contracts, updates the deployments/localhost folder with contract address and abi.
On contract update, will redeploy contract and update deployments folder.
#### `yarn hardhat:deployalfa`
Deploys the contract to Alfajores and records the address in the deployments/alfajores directory
#### `yarn hardhat:deploycelo`
Deploys the contract to Celo and records the address in the deployments/celo directory