non-fungible-apps/ui/README.md

45 lines
1.2 KiB
Markdown

## ⚡ Overview
Minimal UI to interact with the contract, build with [React](https://reactjs.org/). 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](https://nodejs.org/en/) and [YARN](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) installed. Please do not use NPM for package installation.
Also, don't forget to check the [Getting started section](https://github.com/fleekxyz/non-fungible-apps/wiki/%F0%9F%93%98-Getting-Started) 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](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
2. Install the dependencies:
```bash
$ yarn
```
3. Start the local server running the app:
```bash
$ yarn dev
```
Now a local server should be running on [http://localhost:5173](http://localhost:5173).
### 🤖 Build public
As we use vite, to build a public distribution for production run:
```bash
$ vite build
```
This will create a dist folder for the deployment.