Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme.md #34

Merged
merged 1 commit into from
May 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# BotaniQue Backend

## Overview

BotaniQue is a project designed to simplify plant care by providing real-time monitoring and insights into plant conditions. This backend server is a key part of the BotaniQue ecosystem, supporting data processing, real-time updates, and integration with cloud services.

## Project Components

* IoT Device (Smart Plant Pot): An ESP32 microcontroller with sensors for soil moisture, air humidity, temperature, and light, and an OLED screen for displaying the plant's mood.
* Mobile App (Frontend application): Developed in Flutter, it allows users to manage plants and view their conditions.
* Backend Server: Processes data from the IoT device, determines plant health, and provides real-time updates to the mobile application as well as handling authentication, data storage and business logic for the mobile app.

## Technologies Used

* Programming Language: .NET 8 (backend)
* MQTT Broker: Flespi
* Database: PostgreSQL
* WebSockets(using Fleck): For real-time communication
* Azure Cognitive Services: Azure vision for background removal from images
* Azure Blob Storage: For image storage

Run database:
```bash
docker run --name botanique_db -p 5432:5432 -e POSTGRES_PASSWORD=password -e POSTGRES_USER=root -d postgres:14
Expand Down
Loading