Easy Housing (Real Estate Listing Website)

Table of Contents

• About
• Features
• Installation
• Usage
• Technologies Used
• Contributing
• License
• Contact

About

Real Estate Listing Website is a web application built using the MERN stack (MongoDB, Express, React, Node.js). This project allows users to create, view, edit, and delete real estate listings. It includes features like user authentication, viewing listings, and contacting listing creators. The project also integrates Firebase for image storage.

Features

• User Sign In/Sign Up
• Create Real Estate Listings
• View Listings
• Get Contact Information of Listing Creator
• Edit Listings
• Update Listings
• Delete Listings
• Firebase Integration for Image Saving

Installation

To get a local copy up and running, follow these steps:

1. Clone the repository

   https://github.com/sudoyasir/Easy-Housing.git
   

2. Navigate to Easy-Housing folder

   cd Easy-Housing

3. Install api dependencies

   npm install

4. install client dependencies

   cd client && npm install

5. Rename .env.example to .env in root directory and client folder and insert your credentials.

6. Start Client by

   npm run dev
   

7. Start Server by

   npm start
   

8. Visit http://localhost:5173/ for live preview in your browser

Usage

1. Sign Up / Sign In

Users can sign up or sign in to create and manage their listings.

2. Create Listings

Once logged in, users can create new real estate listings by providing details and uploading images.

3. View Listings

Users can browse through all the available listings and view detailed information about each listing.

4. Contact Listing Creator

Users can get the contact information of the listing creator to inquire further.

5. Edit / Update / Delete Listings

Users can edit, update, or delete their own listings.

Technologies Used

Frontend:

• React
• Redux
• Tailwind CSS
• Firebase Storage

Backend:

• Node.js
• Express
• MongoDB
• Mongoose

Authentication:

• JWT (JSON Web Tokens)
• Firebase Authentication

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Yasir Nawaz - y451rmahar@gmail.com - yasirnawaz.me