non-fungible-apps/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.

🖥️ Running

To run the UI localy follow the steps:

1. Clone the repo, check out how here.

2. Install the dependencies:

   $ yarn
   

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

4. 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.