{"id":25684711,"url":"https://github.com/kudzaiprichard/spring-realestate-api","last_synced_at":"2026-04-12T00:06:27.567Z","repository":{"id":199497030,"uuid":"680261016","full_name":"kudzaiprichard/spring-realestate-api","owner":"kudzaiprichard","description":"Real-estate restful API with java spring boot and MySQL ","archived":false,"fork":false,"pushed_at":"2023-10-10T13:20:03.000Z","size":788,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-10-10T15:30:03.345Z","etag":null,"topics":["intelij","java","jwt","jwt-authentication","maven","mysql","spring","spring-boot","spring-mvc","spring-security","sql"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kudzaiprichard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-18T18:36:01.000Z","updated_at":"2023-10-10T15:30:20.644Z","dependencies_parsed_at":"2023-10-10T15:30:18.006Z","dependency_job_id":null,"html_url":"https://github.com/kudzaiprichard/spring-realestate-api","commit_stats":null,"previous_names":["kudzaiprichard/spring-realestate-api"],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kudzaiprichard%2Fspring-realestate-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kudzaiprichard%2Fspring-realestate-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kudzaiprichard%2Fspring-realestate-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kudzaiprichard%2Fspring-realestate-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kudzaiprichard","download_url":"https://codeload.github.com/kudzaiprichard/spring-realestate-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240524217,"owners_count":19815239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["intelij","java","jwt","jwt-authentication","maven","mysql","spring","spring-boot","spring-mvc","spring-security","sql"],"created_at":"2025-02-24T17:32:33.296Z","updated_at":"2026-04-12T00:06:27.533Z","avatar_url":"https://github.com/kudzaiprichard.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/kudzaiprichard/realestate-backend\"\u003e\n    \u003cimg src=\"images/logo/logo.jpg\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eReal Estate Backend\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A real estate restful api backend \n    \u003cbr /\u003e\n  \u003c/p\u003e\n  \u003cbr/\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#project-scope\"\u003eProject Scope\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#project-design\"\u003eProject Design\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n# About The Project\n\n### Project Scope\n\nThe real estate marketplace works as a mediator between homeowners and buyers/renters. Property owners can list their estate on the site,\nset 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.\n\n* Real estate agents can create accounts and advertise and sell there property\n* Customer can view listed estates and can filter through this list of estate\n* Customer must then be able to contact estate agent through that particular advert\n\n## Project Design\n\n### Architecture\nSystem uses REST API Architecture. REST stands for Representational State Transfer Application Programming Interface, is a popular architectural \nstyle for designing networked applications. It allows different software systems to communicate with each other by \nexchanging data over the internet, typically using the HTTP protocol.\n\n\u003cimg src=\"images/architecture.jpg\" alt=\"architecture Diagram\" \u003e\n\nThis will architecture is scalable, flexible and lightweight and allows for other third party software, mobile, web written\nin different languages to easily integrate with our services\n\n### Endpoit Design\nBelow is a screenshot of the project restful api endpoints and the HTTP Method supported by each endpoint\n\n\u003cimg src=\"images/realestate-endpoints-docs.png\" alt=\"endpoints\" \u003e\n\n### UML Diagram\nBelow is the UML design of the system including relationships between the difference objects that make up the system\n\n\u003cimg src=\"images/realestate-uml.png\" alt=\"UML Diagram\" height=\"900\"\u003e\nThe bottom diagram extends the one above and takes precedence in any data conflict\n\u003cimg src=\"images/QUADRILATERAL INVESTMENT DEV UML.png\" alt=\"UML Diagram Extended\" height=\"900\"\u003e\n\n### Built With\nUsed Java spring boot , MySQL and Jason Web Token to build the rest api, including postman for testing.\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"images/logo/java.png\" alt=\"spring\" width=\"100\" height=\"80\" style=\"margin-right: 20px;\"\u003e \n    \u003cimg src=\"images/logo/spring.png\" alt=\"spring\" width=\"160\" height=\"82\" style=\"margin-right: 20px;\"\u003e \n    \u003cimg src=\"images/logo/mysql.webp\" alt=\"mysql\" width=\"110\" height=\"80\" style=\"margin-right: 20px;\"\u003e\n    \u003cimg src=\"images/logo/jwt.png\" alt=\"jwt\" width=\"85\" height=\"80\"\u003e\n\u003c/div\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n### Prerequisites\n\nYou should have the below softawares installed in your pc :\n* JDK 21 and JRE\n* MySQL\n* and your preferred IDE or text editor\n\n  \n\n### Installation\n\n1. Get a free API Key at [https://github.com/settings/tokens](https://github.com/settings/tokens)\n2. Clone the repo\n\n   ```sh\n   git clone https://github.com/kudzaiprichard/spring-realestate-api\n   ```\n\n3. Open project in IDE or text editor\n4. let maven download all necessary dependency for the project to run\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!--CONTRIBUTING--\u003e\n## Contributing\n\nIf 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\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n### :fire: Contribution\n\n Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.\n\n 1. **Report a bug** \u003cbr\u003e\n 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.\n\n 2. **Request a feature** \u003cbr\u003e\n You can also request for a feature [here](), and if it will viable, it will be picked for development.  \n\n 3. **Create a pull request** \u003cbr\u003e\n 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.\n\n \u003e If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nKudzai P Matizirofa - [linkedin.com/in/kudzai-prichard](www.linkedin.com/in/kudzai-prichard) - \u003ckudzaiprichard@gmail.com\u003e\n\nProject Link: [https://github.com/kudzaiprichard/spring-realestate-api](https://github.com/kudzaiprichard/spring-realestate-api)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n## Acknowledgments\n\nlist of resources I found helpful and would like to give credit to.\n\n* [Choose an Open Source License](https://choosealicense.com)\n* [Restful Api Explained](https://aws.amazon.com/what-is/restful-api/)\n* [Jason Web Tokens](https://jwt.io/)\n* [Spring Boot docs](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/)\n* [GitHub Pages](https://pages.github.com) \n* [MySql docs](https://dev.mysql.com/doc/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkudzaiprichard%2Fspring-realestate-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkudzaiprichard%2Fspring-realestate-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkudzaiprichard%2Fspring-realestate-api/lists"}