-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,28 @@ | ||
| # 🏗 Scaffold-ETH 2 | ||
| # Estate-web3 🏠 | ||
|
|
||
| <h4 align="center"> | ||
| <a href="https://docs.scaffoldeth.io">Documentation</a> | | ||
| <a href="https://scaffoldeth.io">Website</a> | ||
| </h4> | ||
| A decentralized real estate platform built on Arbitrum that enables property listing, buying, and renting with cryptocurrency payments and smart contract integration. | ||
|
|
||
| 🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts. | ||
| ## Features 🌟 | ||
|
|
||
| ⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript. | ||
| - Property Listing & Management | ||
| - Buy/Rent Properties with Cryptocurrency | ||
| - Smart Contract-based Transactions | ||
| - Fractional Property Ownership | ||
| - Collateralized Payments Support | ||
| - Interactive Property Search | ||
| - Secure Wallet Integration | ||
|
|
||
| - ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it. | ||
| - 🪝 **[Custom hooks](https://docs.scaffoldeth.io/hooks/)**: Collection of React hooks wrapper around [wagmi](https://wagmi.sh/) to simplify interactions with smart contracts with typescript autocompletion. | ||
| - 🧱 [**Components**](https://docs.scaffoldeth.io/components/): Collection of common web3 components to quickly build your frontend. | ||
| - 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet. | ||
| - 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network. | ||
| ## Tech Stack 💻 | ||
|
|
||
|  | ||
| - **Frontend**: Next.js 14, TypeScript, TailwindCSS, DaisyUI | ||
| - **Blockchain**: Hardhat, Arbitrum, Solidity | ||
| - **Web3 Integration**: Wagmi, Viem, RainbowKit | ||
| - **File Storage**: Pinata IPFS | ||
| - **Development Tools**: Yarn, Prettier, ESLint | ||
|
|
||
| ## Requirements | ||
| ## Contracts 📜 | ||
|
|
||
| Before you begin, you need to install the following tools: | ||
|
|
||
| - [Node (>= v18.18)](https://nodejs.org/en/download/) | ||
| - Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install)) | ||
| - [Git](https://git-scm.com/downloads) | ||
|
|
||
| ## Quickstart | ||
|
|
||
| To get started with Scaffold-ETH 2, follow the steps below: | ||
|
|
||
| 1. Install dependencies if it was skipped in CLI: | ||
|
|
||
| ``` | ||
| cd my-dapp-example | ||
| yarn install | ||
| ``` | ||
|
|
||
| 2. Run a local network in the first terminal: | ||
|
|
||
| ``` | ||
| yarn chain | ||
| ``` | ||
|
|
||
| This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in `packages/hardhat/hardhat.config.ts`. | ||
|
|
||
| 3. On a second terminal, deploy the test contract: | ||
|
|
||
| ``` | ||
| yarn deploy | ||
| ``` | ||
|
|
||
| This command deploys a test smart contract to the local network. The contract is located in `packages/hardhat/contracts` and can be modified to suit your needs. The `yarn deploy` command uses the deploy script located in `packages/hardhat/deploy` to deploy the contract to the network. You can also customize the deploy script. | ||
|
|
||
| 4. On a third terminal, start your NextJS app: | ||
|
|
||
| ``` | ||
| yarn start | ||
| ``` | ||
|
|
||
| Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the `Debug Contracts` page. You can tweak the app config in `packages/nextjs/scaffold.config.ts`. | ||
|
|
||
| Run smart contract test with `yarn hardhat:test` | ||
|
|
||
| - Edit your smart contracts in `packages/hardhat/contracts` | ||
| - Edit your frontend homepage at `packages/nextjs/app/page.tsx`. For guidance on [routing](https://nextjs.org/docs/app/building-your-application/routing/defining-routes) and configuring [pages/layouts](https://nextjs.org/docs/app/building-your-application/routing/pages-and-layouts) checkout the Next.js documentation. | ||
| - Edit your deployment scripts in `packages/hardhat/deploy` | ||
|
|
||
|
|
||
| ## Documentation | ||
|
|
||
| Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2. | ||
|
|
||
| To know more about its features, check out our [website](https://scaffoldeth.io). | ||
|
|
||
| ## Contributing to Scaffold-ETH 2 | ||
|
|
||
| We welcome contributions to Scaffold-ETH 2! | ||
|
|
||
| Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2. | ||
| - **tUSDC.sol**: Test USDC token on Arbitrum Sepolia used for transactions on the platform | ||
| - **PropertyNFT.sol**: Represents a property as NFT and manages its ownership and transfer. | ||
| - **Marketplace.sol**: Manages the buying and selling of properties, including the creation of listings, bidding, and settlement. | ||
| - **MarketplaceFractional.sol**: Manages the fractional ownership of properties, including the creation of fractional listings, bidding, and settlement. |