Home automation project

This repo is a part of an "Agile software development" class at University of Economics in Katowice.

The project is about building a hub connecting multiple IoT devices in a smart home. It will consit of a mqtt broker, connected to a central hub subscribing and publishing to some dummy devices (possible to replace with real ones). It will provide REST and GraphQL APIs.

Development

For more info about how to work on the project, go to respective project directories and check their READMEs.

Deployment

To build a docker image run:

docker build . -t <your tag>

Git workflow

Prepare your fork

Fork this repository to your own github account.
Clone your fork to you computer

Add this repository as upstream

 git remote add upstream git@github.com:owocowe-piatki/home-automation.git

To update your fork to the most recent one, run (in your main branch):

git pull --rebase upstream main

git push # to sync with your fork on github

To work on a feature, create a feature branch

git checkout main # switch to main branch

# update to the latest version, look at the point above

git checkout -b <your feature branch name>

After you finish your work, go to github and create a pull request from your fork to the main repository

To create a pull request, follow the requirements

Pull request title

Pull request has to follow the "HA-{Jira issue number}:" syntax For hotfixes "HOTFIX:" prefix is allowed

The regex is as follows

   (HA-\d+|HOTFIX):

Pull request comment

Pull request comment should follow this pull request template

This code block should be replaced with a commit message submitted
during squash and merge.