/MyHome

A Java application which helps people to manage their apartment.

Primary LanguageJavaApache License 2.0Apache-2.0

Logo

MyHome helps people manage their apartment. See this document for the complete list of features we are planning to implement.

Join us at Discord here.

License Java CI with Gradle Codecoverage Discord Good First Issue

Table of Contents

Installing

Prerequisites

  • Gradle
  • Java 8 (JDK)
  • Docker for running service inside container (You can also run it without docker)

Building

  1. Download the Project to local drive
  2. Run gradlew assemble
  3. Frontend is developed using React and is here

Running using Docker

docker-compose build
docker-compose up

All required ports are mapped to localhost.

REST API is accessible via port 8080.

http://localhost:8080/swagger/index.html - serves an API documentation.

Contributors

Made with contributors-img

How do I contribute?

Feel free to contribute to the project. Please make sure to follow the below list before contributing.

API exploration

Our API can be accessed in two ways:

License

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

Acknowledgments

This project relies on the following projects

  • Spring Framework
  • Docker
  • Cover image taken from Unsplash Brandon Griggs