Giter Club home page Giter Club logo

myhome's Introduction

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

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

myhome's People

Contributors

ddmit04 avatar jmprathab avatar mslowiak avatar edwardul99 avatar edwin9870 avatar amirabramovich avatar tobi406 avatar sountastic avatar gangadhargo avatar rmgrimm avatar tomsajuk avatar hemantjoshi11 avatar jannesickert avatar jufab avatar wolfi3654 avatar ubaldop avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.