Table of Contents
The real estate marketplace works as a mediator between homeowners and buyers/renters. Property owners can list their estate on the site, set the approximate price, and find the customers. Customers, on the other hand, can search for a place, check property photos, building plans, and overall descriptions.
- Real estate agents can create accounts and advertise and sell there property
- Customer can view listed estates and can filter through this list of estate
- Customer must then be able to contact estate agent through that particular advert
System uses REST API Architecture. REST stands for Representational State Transfer Application Programming Interface, is a popular architectural style for designing networked applications. It allows different software systems to communicate with each other by exchanging data over the internet, typically using the HTTP protocol.
This will architecture is scalable, flexible and lightweight and allows for other third party software, mobile, web written in different languages to easily integrate with our services
Below is a screenshot of the project restful api endpoints and the HTTP Method supported by each endpoint
Below is the UML design of the system including relationships between the difference objects that make up the system
Used Java spring boot , MySQL and Jason Web Token to build the rest api, including postman for testing.
You should have the below softawares installed in your pc :
- JDK 21 and JRE
- MySQL
- and your preferred IDE or text editor
-
Get a free API Key at https://github.com/settings/tokens
-
Clone the repo
git clone https://github.com/kudzaiprichard/spring-realestate-api
-
Open project in IDE or text editor
-
let maven download all necessary dependency for the project to run
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.
-
Report a bug
If you think you have encountered a bug, and I should know about it, feel free to report it here and I will take care of it. -
Request a feature
You can also request for a feature here, and if it will viable, it will be picked for development. -
Create a pull request
It can't get better than this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.
If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.
Distributed under the MIT License. See LICENSE.txt for more information.
Kudzai P Matizirofa - linkedin.com/in/kudzai-prichard - kudzaiprichard@gmail.com
Project Link: https://github.com/kudzaiprichard/spring-realestate-api
list of resources I found helpful and would like to give credit to.