non-fungible-apps/ui
Camila Sosa Morales 2560181c74
chore: UI verification step separate (#147)
* feat: add switch component

* chore: add verify step

* chore: move form-step folder

* chore: add text component

* chore: add nfa step to context

* chore: add text on Verify NFA Step
2023-03-01 16:35:08 -05:00
..
.storybook chore: remove chakra (#86) 2023-01-26 16:02:08 -05:00
src chore: UI verification step separate (#147) 2023-03-01 16:35:08 -05: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 UI 11: refactor vite.config.json (#20) 2022-12-05 15:15:21 -03:00
.prettierrc feat: boilerplate for UI (#14) 2022-12-01 10:25:30 -03:00
README.md feat: UI connect kit integration (#136) 2023-02-23 14:54:01 -05:00
index.html feat: UI connect kit integration (#136) 2023-02-23 14:54:01 -05:00
package.json fix: ck fix other wallet connections (#142) 2023-02-28 10:58:20 -05:00
postcss.config.js chore: add tailwind and stitches (#75) 2023-01-18 11:41:08 -05:00
tailwind.config.js chore: UI verification step separate (#147) 2023-03-01 16:35:08 -05:00
tsconfig.json chore: precommit hooks (#18) 2022-12-16 14:57:49 -03:00
vite.config.ts fix: ck fix other wallet connections (#142) 2023-02-28 10:58:20 -05:00
yarn.lock fix: ck fix other wallet connections (#142) 2023-02-28 10:58:20 -05: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. 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.