Quickstart

StellarRent: Redefining Rentals with Blockchain 🏠

StellarRent is a property rental platform built on the Stellar blockchain, enabling decentralized and secure property listings, rentals, and management.

What is StellarRent?

StellarRent utilizes smart contracts on the Stellar blockchain to:

  • List properties as an owner

  • Rent properties as a tenant

  • Confirm rentals as an owner

  • Make secure payments using blockchain technology

Step-by-Step Guide for Absolute Beginners

Prerequisites

  1. A computer with an internet connection

  2. A web browser (Chrome, Firefox, etc.)

  3. A terminal/command line (pre-installed on your OS)

Step 1: Install Node.js

Node.js is required to run the application.

  1. Download the "LTS" (Long-Term Support) version

  2. Follow the installation instructions

To verify that Node.js is installed correctly, open the terminal and type:

node -v

You should see something like v18.x.x or higher.

Step 2: Install Git

Git is required to download the code.

  • Windows: Download from git-scm.com

  • Mac: Open Terminal and type git --version. If it's not installed, you’ll be prompted to install it.

  • Linux: Use your package manager (e.g., sudo apt-get install git on Ubuntu)

Step 3: Download the Project

  1. Open the terminal

  2. Navigate to the folder where you want to save the project:

cd Documents
  1. Clone the repository:

git clone https://github.com/your-username/stellar-dapp.git
cd stellar-dapp

Step 4: Install Dependencies

In the terminal, inside the project folder, run:

npm install

This may take a few minutes. It installs all necessary libraries for the project.

Step 5: Install the Freighter Wallet

Freighter is the digital wallet used to interact with the Stellar blockchain.

  1. Click "Add to Browser" for your browser

  2. Follow the instructions to create a new wallet

  3. IMPORTANT! Store your recovery phrase in a safe place

Step 6: Get Test Funds

To use the Stellar test network, you need free test tokens:

  1. Copy your public address from Freighter

  2. Paste it into the address field and create a test account

Step 7: Start the Application

In the terminal, run:

npm run dev

When you see a message like "localhost:3000 ready," the application is running.

Step 8: Use the Application

  1. Open your browser and go to http://localhost:3000

  2. Connect your Freighter wallet by clicking "Connect Wallet"

  3. Now you can:

    • List a property: Click on your profile and select "List Property"

    • Rent a property: Browse available properties and click "Rent"

    • View details: Click on any property to see more information

Common Troubleshooting

"Connect Wallet" Button Not Working?

  • Make sure Freighter is installed and logged in

  • Check that you’re on the "Testnet" network

Error Listing or Renting a Property?

  • Ensure you have enough funds in your test account

  • Verify you are connected to the correct network in Freighter

Application Won’t Start?

  • Check that Node.js is installed correctly

  • Make sure you are inside the correct project folder

  • Try running npm install again

Useful Resources

What is Stellar?

Stellar is an open-source blockchain network designed to facilitate cross-border payments and transactions. It offers:

  • Fast transactions (under 5 seconds)

  • Low fees (fractions of a cent)

  • Energy efficiency (sustainable and low consumption)

  • Smart contracts powered by Soroban

Why Use Stellar for Rentals?

  • Security: Transactions and contracts are immutable and transparent

  • Efficiency: Instant payments without intermediaries

  • Trust: No need for third parties to guarantee payments

  • Global Reach: Works anywhere in the world

Last updated