Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anchit1909/blockbnb-decentralized-house-rental-platform
BlockBnb is a decentralized application built on the Ethereum blockchain. It is a rental marketplace where users can list, book, and review apartments. The project revolves around DappBnb.sol, a Solidity-written Ethereum smart contract. It leverages the OpenZeppelin library to ensure secure and standardized development of the contract.
https://github.com/anchit1909/blockbnb-decentralized-house-rental-platform
alchemy blockchain dapp etherjs javascript nextjs redux-toolkit smart-contracts solidity tailwindcss walletconnect web3
Last synced: 24 days ago
JSON representation
BlockBnb is a decentralized application built on the Ethereum blockchain. It is a rental marketplace where users can list, book, and review apartments. The project revolves around DappBnb.sol, a Solidity-written Ethereum smart contract. It leverages the OpenZeppelin library to ensure secure and standardized development of the contract.
- Host: GitHub
- URL: https://github.com/anchit1909/blockbnb-decentralized-house-rental-platform
- Owner: Anchit1909
- License: mit
- Created: 2024-04-12T07:36:36.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-14T12:50:35.000Z (10 months ago)
- Last Synced: 2024-11-11T17:34:14.626Z (3 months ago)
- Topics: alchemy, blockchain, dapp, etherjs, javascript, nextjs, redux-toolkit, smart-contracts, solidity, tailwindcss, walletconnect, web3
- Language: JavaScript
- Homepage: https://decentralized-house-rental-platform.vercel.app
- Size: 4.12 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
BlockBnb - Decentralized House Rental Platform
List, book, and review your apartments.
Introduction ·
Features ·
Tech Stack ·
Screenshots ·
Running Locally ·
Author
## Introduction
BlockBnb is a decentralized application built on the Ethereum blockchain. It is a rental marketplace where users can list, book, and review apartments. The project revolves around `DappBnb.sol`, a Solidity-written Ethereum smart contract. It leverages the OpenZeppelin library to ensure secure and standardized development of the contract.
The core of the contract is defined by three primary structures: `ApartmentStruct`, `BookingStruct`, and `ReviewStruct`, representing an apartment, a booking, and a review, respectively.
## Features
- `createAppartment`: Allows a user to create a new apartment listing.
- `updateAppartment`: Allows the apartment owner to update the details of an apartment.
- `deleteAppartment`: Allows the apartment owner to delete an apartment listing.
- `getApartments`: Allows a user to fetch all available apartments.
- `getApartment`: Allows a user to fetch the details of a specific apartment.
- `bookApartment`: Allows a user to book an apartment for specific dates.
- `checkInApartment`: Allows a tenant to check into an apartment and triggers the payment process.
- `claimFunds`: Allows the apartment owner to claim funds after a booking is completed.
- `refundBooking`: Allows a tenant to cancel a booking and get a refund.
- `getUnavailableDates`: Allows a user to fetch all booked dates for a specific apartment.
- `getBookings`: Allows a user to fetch all bookings for a specific apartment.
- `getBooking`: Allows a user to fetch the details of a specific booking.
- `addReview`: Allows a tenant to add a review for an apartment.
- `getReviews`: Allows a user to fetch all reviews for a specific apartment.
## Tech Stack
- Javascript
- [Solidity](https://soliditylang.org/)
- [NextJS](https://nextjs.org/)
- [Hardhat](https://hardhat.org/)
- [Alchemy](https://dashboard.alchemy.com/)
- [EthersJs](https://docs.ethers.io/v5/)
- [Redux-Toolkit](https://redux-toolkit.js.org/)
- [Tailwind CSS](https://tailwindcss.com/)
## Screenshots
### Home Page
### Room Page
### Edit Room Page
### Add Room Page
### Bookings Page
### Add Review
## Running Locally
Supply the following keys in your `.env` variable:
```sh
NEXT_PUBLIC_RPC_URL=http://127.0.0.1:8545
NEXT_PUBLIC_ALCHEMY_ID=
NEXT_PUBLIC_PROJECT_ID=
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=somereallysecretsecret
```
`YOUR_ALCHEMY_PROJECT_ID`: [Get Key Here](https://dashboard.alchemy.com/)
`WALLET_CONNECT_PROJECT_ID`: [Get Key Here](https://cloud.walletconnect.com/sign-in)
Follow these steps to run the application:
1. Install the package modules by running the command: `yarn install`
2. Start the Hardhat server: `yarn blockchain`
3. Run the contract deployment script: `yarn deploy`
4. Run the contract seeding script: `yarn seed`
5. Spin up the Next.js development server: `yarn dev`
Now, your application should be up and running.
## Author
- Anchit Sinha ([@anchit1909](https://twitter.com/anchit1909))