Skip to content

Commit

Permalink
Update readme add env.example file
Browse files Browse the repository at this point in the history
  • Loading branch information
coddeys committed Jun 27, 2024
1 parent a6a4d27 commit 65ff538
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 11 deletions.
4 changes: 4 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
DENO_KV_ACCESS_TOKEN=DENO_KV_ACCESS_TOKEN
BLOCKFROST=BLOCKFROST
POLICY_ID=POLICY_ID
ASSET=ASSET
43 changes: 32 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,50 @@

> Emurgo Academy Final Project
## Mint Platform NFT
## Project Overview

1. Go to https://estate-club.deno.dev/admin
The idea of the project is to fractionalize real estate property. The minimum amount is a square decimeter. The manager creates a bid with the address, size, and price of the property. The bid is a Cardano smart contract, and every contract is unique because the validator uses UTXO-ref as an input. While creating the Plutus Script, the manager mints tokens in an amount equal to the size of the property and locks the tokens on the script address.

2. Connect the Nami Wallet by clicking the "Setup Lucid" button
Investors then start to lock ADA on the script. If the amount of ADA is equal to or more than the price of the property, the bid is funded, and the manager can distribute tokens between investors and unlock the ADA from the script. If the bid is not funded, investors can request a refund. Every investor can always refund (unlock) their own ADA.

3. Click the Mint button
## Developer Guide

[platform_nft.webm](https://github.com/coddeys/fractional-nft-real-estate/assets/4198294/b360f8d5-7c6c-4614-a221-fa29d70addb8)
### Development Smart Contracts

## Development
To build the compiled version code, use the following command:

Then start the project:
```
aiken build --trace-level verbose
```

### Development Frontend

Start the frontend project:

```
deno task start
```

This will watch the project directory and restart as necessary.
This command will monitor the project directory and restart as needed.

## Deployment
### Deployment

The project will be automatically released to the Deno Deploy platform using a
GitHub workflow.
The project will be automatically deployed to the Deno Deploy platform using a GitHub workflow.

https://estate-club.deno.dev/


# User Guide

## Mint Platform NFT

1. Visit https://estate-club.deno.dev/admin

2. Connect the Nami Wallet by clicking the "Setup Lucid" button

3. Click the Mint button

Visual guide:

[platform_nft.webm](https://github.com/coddeys/fractional-nft-real-estate/assets/4198294/b360f8d5-7c6c-4614-a221-fa29d70addb8)

0 comments on commit 65ff538

Please sign in to comment.