Skip to content

Latest commit

 

History

History
93 lines (73 loc) · 2.63 KB

README.md

File metadata and controls

93 lines (73 loc) · 2.63 KB
Raw

Home360

Home360 is an online real estate web application. It allows users to rent both private and commercially available houses and apartment.

Built with

Features

  • User registration
  • User login with JWT authentication
  • Password reset
  • Refresh token
  • Password change
  • Account verification
  • Listing creation
  • Listing deletion
  • Search listings
  • Fetch listings
  • Make listing enquiry
  • Mark listing enquiry as read
  • Fetch listing enquiries
  • In-app messaging
  • Rate limiting

Getting Started

To get started with this project you'd need to have the following installed on your local computer:

  • JDK 17+
  • Maven 3+
  • PostgreSQL
  • MongoDB
  • Docker (optional if you only want to run it locally)

To build and run the project follow the steps below

  • Clone the repository https://github.com/Hoxtygen/home360-server.git
  • Open a terminal and navigate to the project directory: cd home360
  • Add home360_dev to your local Postgres database
  • Add home360dev to your local MongoDB database
  • Create a .env file and add the following
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_DATABASE=home360_dev
POSTGRES_LOCAL_PORT=
POSTGRES_DOCKER_PORT=

MONGODB_USER=
MONGODB_PASSWORD=
MONGODB_DATABASE=home360dev
MONGODB_LOCAL_PORT=27017
MONGODB_DOCKER_PORT=27017

SPRING_LOCAL_PORT=8080
SPRING_DOCKER_PORT=8080
  • Create a application-dev.yml file and add to the resources' directory. Check the application-sample-dev.yml for content to fill it up with.

There are 2 ways to run the app

  1. Using the docker compose file
  • docker-compose up --build
  • This will start the app on port 8000
  1. Running a local version of the Spring boot app
  • Build the project : mvn clean install
  • Run the project: mvn spring-boot:run

Documentation

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Author