-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9e35a2c
commit ef1e9f1
Showing
1 changed file
with
29 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,44 @@ | ||
| ## RoyalLands - MERN Stack Real Estate Website | ||
|
|
||
| RoyalLands is a full-stack web application built using the MERN (MongoDB, Express, React, Node.js) stack. This web application allows property agents to list their properties, and users or investors can view listings, request to rent a property, or contact the agent through a live chat service. The web application is designed to simplify the process of finding and renting properties, making it easier for users to browse through available properties and connect with agents. | ||
| Installation | ||
| # RoyalLands - MERN Stack Real Estate Website | ||
|
|
||
| To install RoyalLands, follow these steps: | ||
| RoyalLands is a full-stack web application built using the MERN (MongoDB, Express, React, Node.js) stack. This web application allows property agents to list their properties, and users or investors can view listings, request to rent a property, or contact the agent through a live chat service. The web application is designed to simplify the process of finding and renting properties, making it easier for users to browse through available properties and connect with agents. | ||
|
|
||
| Clone the repository onto your local machine. | ||
| Navigate to the root directory of the project in your terminal. | ||
| Run npm install to install the dependencies. | ||
| Create a .env file in the root directory and add your MongoDB database URL. | ||
| Run npm start to start the server and client | ||
| RoyalLands is designed to be user-friendly, with a clean and intuitive interface. Users can browse through the listings and filter them by various criteria, such as location, price, and property type. Each property listing includes detailed information about the property, including images, price, and description. Users can also request to rent a property directly from the listing page or use the live chat service to contact the agent in real-time. | ||
|
|
||
| Property agents can use the agent dashboard to add new property listings, update existing listings, and manage requests from potential renters. The dashboard also includes analytics and insights about the performance of their listings. | ||
| ## Installation | ||
|
|
||
| To install RoyalLands, follow these steps | ||
|
|
||
| Features | ||
| ```bash | ||
| Clone the repository onto your local machine. | ||
| Navigate to the root directory of the project in your terminal. | ||
| Run npm install to install the dependencies. | ||
| Run npm start to start the server and client | ||
| ``` | ||
|
|
||
| ## Features | ||
|
|
||
| The key features of the RoyalLands web application include: | ||
|
|
||
| Property listings page with filters for search | ||
| Individual property pages with detailed information and images | ||
| Request to rent a property functionality | ||
| Live chat service to connect with agents in real-time | ||
| Agent dashboard to list and manage properties | ||
| - Property listings page with filters for search | ||
| - Individual property pages with detailed information and images | ||
| - Request to rent a property functionality | ||
| - Live chat service to connect with agents in real-time | ||
| - Agent dashboard to list and manage properties | ||
|
|
||
| Usage | ||
|
|
||
| RoyalLands is designed to be user-friendly, with a clean and intuitive interface. Users can browse through the listings and filter them by various criteria, such as location, price, and property type. Each property listing includes detailed information about the property, including images, price, and description. Users can also request to rent a property directly from the listing page or use the live chat service to contact the agent in real-time. | ||
| ## Authors | ||
|
|
||
| Property agents can use the agent dashboard to add new property listings, update existing listings, and manage requests from potential renters. The dashboard also includes analytics and insights about the performance of their listings. | ||
| Contributing | ||
| - [@IT21112300 Chandrasiri G.K.N.N](https://www.github.com/NirmalNaveen20) | ||
|
|
||
| - [@T21138072 Karunarathna W. P. D. B](https://www.github.com/T21138072) | ||
|
|
||
| If you wish to contribute to RoyalLands, please follow these steps: | ||
| - [@IT21112300 Shashikala W. A. A.](https://www.github.com/IT21112300) | ||
|
|
||
| Fork the repository onto your GitHub account. | ||
| Clone the forked repository onto your local machine. | ||
| Create a new branch for your changes. | ||
| Make your changes and commit them to the new branch. | ||
| Push the new branch to your forked repository. | ||
| Create a pull request to merge your changes into the main repository. | ||
| - [@IT21128554 Weerasooriya K.A.M](https://www.github.com/IT21128554) | ||
|
|
||
| License | ||
|
|
||
| RoyalLands is licensed under the MIT license. See the LICENSE file for more details. | ||
| Contact | ||
| ## Support | ||
|
|
||
| If you have any questions or suggestions, please feel free to contact us at | ||
| [email protected] | ||
| If you have any questions or suggestions, please feel free to contact us at [email protected] |