non-fungible-apps/ui
Felipe Mendes 099e6d76d6
chore: UI polyfills for build command (#165)
* chore: fix vite plugin for polyfills

* chore: add prod script command to run production version

* refactor: hash router to run on ipfs
2023-03-08 17:56:36 -03:00
..
.storybook chore: remove chakra (#86) 2023-01-26 16:02:08 -05:00
graphql chore: UI setup subgraph querying (#152) 2023-03-08 15:28:16 -05:00
src chore: UI polyfills for build command (#165) 2023-03-08 17:56:36 -03:00
.eslintignore feat: boilerplate for UI (#14) 2022-12-01 10:25:30 -03:00
.eslintrc.js feat: integrate firebase for github login (#132) 2023-02-23 13:38:51 -05:00
.gitignore chore: UI setup subgraph querying (#152) 2023-03-08 15:28:16 -05:00
.graphclientrc.yml chore: UI setup subgraph querying (#152) 2023-03-08 15:28:16 -05:00
.prettierrc feat: boilerplate for UI (#14) 2022-12-01 10:25:30 -03:00
README.md chore: UI setup subgraph querying (#152) 2023-03-08 15:28:16 -05:00
index.html feat: UI connect kit integration (#136) 2023-02-23 14:54:01 -05:00
package.json chore: UI polyfills for build command (#165) 2023-03-08 17:56:36 -03:00
postcss.config.js chore: add tailwind and stitches (#75) 2023-01-18 11:41:08 -05:00
tailwind.config.js feat: UI integrate ens dropdown (#143) 2023-03-07 08:03:53 -05:00
tsconfig.json chore: UI setup subgraph querying (#152) 2023-03-08 15:28:16 -05:00
vite.config.ts chore: UI polyfills for build command (#165) 2023-03-08 17:56:36 -03:00
yarn.lock chore: UI polyfills for build command (#165) 2023-03-08 17:56:36 -03:00

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

  1. Build the queries to run the project:

    $ yarn graphclient build
    
  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.