Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 2.14 KB

README.md

File metadata and controls

77 lines (49 loc) · 2.14 KB

Roofr

Roofr is a real estate website designed to help users browse, buy, sell, or rent properties. This project is built with Next.js and TypeScript, providing a seamless, modern web experience.

Features

  • Property Listings: Browse a variety of property listings including homes, apartments, and commercial spaces.
  • Property Search: Search for properties based on location, price range, and other filters.
  • Real-time Updates: Stay up-to-date with the latest property listings and market trends.
  • User Authentication: (If implemented) Users can sign up, log in, and save favorite properties.

Technologies Used

  • Next.js: A React-based framework for building modern web applications.
  • TypeScript: A superset of JavaScript that adds static typing, improving code quality and maintainability.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • MongoDB: (If applicable) A NoSQL database used to store property data and user information.
  • Vercel: For deploying the Next.js application (optional).

Getting Started

Prerequisites

Before you begin, make sure you have the following installed:

Installation

  1. Clone the repository:

    git clone https://github.com/shawaiz-khan/roofr.git

  2. Navigate to the project directory:

    cd roofr

  3. Install the dependencies:

    yarn install

    or, if using npm:

    npm install

  4. Set up your environment variables (if any). Create a .env.local file in the root of the project and add your configurations (e.g., MongoDB connection strings, API keys, etc.).

  5. Start the development server:

    yarn dev

    or, if using npm:

    npm run dev

    Your app should now be running on http://localhost:3000.

Contributing

Contributions are welcome! Please fork the repository, create a feature branch, and submit a pull request with your changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.