Thea

Selfhosted tea timer with mqtt support

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License

About The Project

A simple selfhosted tea timer so you won't forget your infusion. Supports mqtt to notify to allows integration with many notification setups.

Built With

• 
• Bulma

(back to top)

Getting Started

Installation

Bare metal

Comming soon

Docker compose minimal

1. Create the docker-compose.yaml file

version: "3.9"
volumes:
  - storage
services:
  web:
    image: ghcr.io/fschiltz/thea:main
    ports:
      - "80:80"
    volumes:
      - storage:/app/storage/

2. Run

docker compose up

Docker compose complete

1. Create the docker-compose.yaml file

version: "3.9"
volumes:
   - storage
services:
  web:
    image: ghcr.io/fschiltz/thea:main
    expose:
      - "80"

    volumes:
      - storage:/app/storage/
    env_file:
      - .env

2. Create the .env file

MQTT__HOST=test.com
MQTT__PORT=1883
MQTT__USERNAME=user
MQTT__PASSWORD=password
MQTT__TOPIC=Thea/Tea

Storage__Type=SQLLITE
Storage__Path=storage/db/
Storage__Username=user
Storage__Password=password

3. Run

docker compose up

4. Expose the service to your network with you reverse proxy ( and authentification solution if needed )

From source

1. Clone the repo
2. Install npm packages

cd ./Thea/ClientApp
npm install

3. Run

cd ../..
dotnet run

From source (docker)

1. Clone the repo
2. run the docker

docker compose build
docker compose up

3. Open http://localhost:80

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If 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". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)