Skip to content

Latest commit

 

History

History
 
 

ui

README.md

⚡ Overview

Minimal UI to interact with the contract, build with React. It will allow you to:

  • Mint your site
  • List the minted sites
  • View the details of the minted site

⚙️ Requirements

You'll need to have nodejs and YARN installed. Please do not use NPM for package installation.

Also, don't forget to check the Getting started section on the wiki if you didn't do it yet, cause you need to configure your wallet to be able to mint a site.

Setting Contract Address and ABI

The contract address and ABI is set by pointing ui/src/integrations/ethereum/contracts/FleekERC721.json to the file from the deployment outputs in the contract sub project.

This can be a local deployment or a deployment on one of the networks. This maintains consistency between the deployed contracts and the info in the UI configuration.

🖥️ Running

To run the UI localy follow the steps:

  1. Clone the repo, check out how here.

  2. Install the dependencies:

    $ yarn

    This also will generate the .graphclient folder. Every time you do a change on the queries files, you'll have to build again that folder, to do it run:

    $ yarn graphclient build

  3. To use ConnecKit is neccessary get an Alchemy ID, so create an App and get the credentials. Then set the following .env file

    VITE_ALCHEMY_API_KEY
VITE_ALCHEMY_APP_NAME

    Also, you'll need to set up your firebase cretendials to make work the github login. Add to the .env file the following variables

    VITE_FIREBASE_API_KEY
VITE_FIREBASE_AUTH_DOMAIN
VITE_FIREBASE_PROJECT_ID
VITE_FIREBASE_STORAGE_BUCKET
VITE_FIREBASE_MESSAGING_SENDER_ID
VITE_FIREBASE_APP_ID
VITE_FIREBASE_MEASUREMENT_ID

Get them from the project settings on the firebase dashboard. Read this article to know how to get your porject config

  1. To interact with the contract, you need to set the Goerli RPC. Set this variable on the .env file

    VITE_GOERLI_RPC

  2. Start the local server running the app:

    $ yarn dev

    Now a local server should be running on http://localhost:5173.

🤖 Build public

As we use vite, to build a public distribution for production run:

$ vite build

This will create a dist folder for the deployment.