jeffemmett
/
non-fungible-apps
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
non-fungible-apps/ui
History
Felipe Mendes 2533f162cb
chore: add readme base (#12) 
* chore: add readme base

* chore: add proof of concept section on readme

* chore: add contributing file

* chore: update contributing opening line

* chore: add nft presentable info for contract roadmap

* chore: add developing and testing sections on readme

* chore: remove deploy section on contributing

* chore: add code styling section in readme

* chore: add project structure section in readme

* Add readme with initialization text.

* chore: add user interface section in readme

* update the interactions guide

* Moved test and deployment guides to the main readme and implemented the requested changes.

* Change NPM commands to Yarn commands

* Add a note for forge-std

* docs: fix repo links

* style: add style on readme and remove comments from merge

* docs: add interaction script examples on readme

* docs: remove extra separator

* docs: remove extra separator

* docs: comment mainnet section on readme

* chore: fix repo links on package.json

* docs: update project sctructure

* chore: UI readme (#55)

* docs: update test output examples

* docs: add submodule fetch command

* docs: add new texts mentioned in pr

* docs: add new texts mentioned in pr

* docs: fix hardhat node command

* chore: move POC info to wiki

* docs: remove extra separator

* fix: deployment scripts (#56)

* chore: add comments in .env.example

* chore: update interaction scripts readme section position and link to a deployment guide

* docs: fix hint message position

* doc: add external lobraries section

* chore: update repo name and its bindings (#57)

* docs: update readme libraries section

Co-authored-by: EmperorOrokuSaki <artie.eth@gmail.com>
Co-authored-by: Shredder <110225819+EmperorOrokuSaki@users.noreply.github.com>
Co-authored-by: Camila Sosa Morales <camisosa@fleek.co>
Co-authored-by: Janison Sivarajah <jsonsivar@gmail.com>
 		2022-12-22 11:13:45 -03:00
..
src chore: add readme base (#12) 2022-12-22 11:13:45 -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 chore: add readme base (#12) 2022-12-22 11:13:45 -03:00
index.html feat: boilerplate for UI (#14) 2022-12-01 10:25:30 -03:00
package.json feat: UI metamask integration (#41) 2022-12-20 14:24:41 -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.