/Mern-frontend-P-3

Responsive Real Estate Platform

Primary LanguageJavaScriptMIT LicenseMIT

Real Estate

Live - Responsive Real Estate Platform Frontend

Demo

Watch a video showcasing the project in action :

Real.Estate.Live.mp4

Prerequisites

  • Node.js          - JavaScript runtime built on Chrome's V8 JavaScript engine
  • npm               - Package manager for JavaScript

Installation & Executing the website locally

  • Use the package manager npm to install Real Estate App - Installation
npm install -g npm

Download this repo using

git clone github-repo-url
  • Step-by-step Instruction - Execution
Open terminal

# get into client dir
cd Mern-frontend-P-3

# run client-side
npm run dev

Open another terminal

# get inside server dir
cd Mern-backend-P-3

# run server-side
node .

Folder Structure

The project was made with the intent of hosting it on Cloudflare, Thus shaping it's current folder structure .

Top-level directory layout

.
|
├── client                   # React application source code
|   ├── public                      # Static assets and files served by the React application
│   │ 
│   ├── src                         # React components and assets
│        │ 
|        ├── components                   # Reusable React components
|        ├── context                      # React context providers and consumers
|        ├── hooks                        # Custom React hooks
|        ├── pages                        # Individual pages of the application
|        ├── utils                        # Utility functions and helper files
|        └── App.jsx                      # Main React application component
│   
│   
└── README.md  # Documentation providing an overview of the project and its structure
Main Folder File Name Details
client src App.jsx Entry point for Frontend

Dependencies used

Frontend:

  • react-router-dom
  • react-accessible-accordion
  • react-countup
  • react-icons
  • react-outside-click-handler
  • swiper

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Authors Note

While I was the main developer of this MERN stack project, this project couldn't have even started without the help of these open-source projects, special thanks to:

Version History

  • 0.2
  • 0.1
    • Initial Release

License

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

Acknowledgments

Inspiration, code snippets, etc.