non-fungible-apps/ui
Felipe Mendes d80a07a3af
fix: ui readme broken wiki link (#63)
2022-12-22 14:43:03 -03:00
..
src Release/0.0.1 fixes (#60) 2022-12-22 14:21:00 -03:00
.eslintignore feat: boilerplate for UI (#14) 2022-12-01 10:25:30 -03:00
.eslintrc.js feat: boilerplate for UI (#14) 2022-12-01 10:25:30 -03: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 fix: ui readme broken wiki link (#63) 2022-12-22 14:43:03 -03:00
index.html feat: boilerplate for UI (#14) 2022-12-01 10:25:30 -03:00
package.json Release/0.0.1 fixes (#60) 2022-12-22 14:21:00 -03:00
tsconfig.json chore: precommit hooks (#18) 2022-12-16 14:57:49 -03:00
vite.config.ts chore: precommit hooks (#18) 2022-12-16 14:57:49 -03:00
yarn.lock feat: UI metamask integration (#41) 2022-12-20 14:24:41 -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. 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.