backend

README

Green Ecolution Backend 🌿

Smart irrigation is essential to saving water, reducing staff workload, and cutting costs. This project provides the backend for Green Ecolution — a digital system to manage urban greenery efficiently.

👉 For the frontend implementation, visit the Green Ecolution Frontend.

The backend acts as the interface between the website and the database, managing data about:

• 🌳 Trees
• 🌿 Tree clusters
• 📡 Sensors
• 🗺️ Watering plans
• 🚛 Vehicles
• 👤 Users

In the current setup, sensors are connected to a microcontroller with an LoRaWAN modules. Sensor data is transmitted via LoRaWAN to an MQTT gateway, then forwarded to the server for processing.

Developed in collaboration with TBZ Flensburg, this software is designed to be adaptable for other cities. It originated as a research project within the Applied Computer Science Master's program at the University of Applied Sciences Flensburg.

For further information, visit:

• 🌐 Project website
• 🖥️ Live demo
• 🎓 University of Applied Sciences Flensburg

Quick Start Guide 🚀

To quickly run the application locally:

1. Download the Docker Compose configuration:

wget https://raw.githubusercontent.com/green-ecolution/backend/refs/heads/develop/.docker/docker-compose.yaml

1. Build and launch the application containers:

docker compose up

By default, external services like auth, mqtt, routing, and s3 are disabled but can be enabled via configuration. See the Demo Setup for more details.

👉 Once the service is up and running, you can access it at: http://localhost:8123

Technologies Used ⚙️

• Go (Golang) as the main language
• env for environment configuration
• godotenv for .env file handling
• Fiber as the web framework
• Testify for unit testing

Local Development Setup 💻

For a detailed step-by-step guide on setting up your local development environment, refer to the Local Development Wiki 📖.

Prerequisites

• Golang
• Air for live reload
• Mockery v2.52.2 for generating mocks
• Make
• Docker
• Docker Compose

Initial Setup ⚙️

Install required tools:

make setup

Generate code:

make generate

Start the infrastructure services using Docker Compose. This setup includes:

• a local PostgreSQL database,
• routing services such as Valhalla, ORS and VROOM for route and vehicle scheduling calculations

make infra/up

Running the Project ▶️

With live reload:

make run/live

Without live reload:

make run

👉 Once the service is up and running, you can access it at: http://localhost:3000

How to Contribute 🤝

We welcome contributions! Please follow these guidelines:

1. Fork this repository.
2. Create a topic branch off develop.
3. Commit your changes.
4. Push your branch to your fork.
5. Open a Pull Request.

This project follows:

• Git-Flow Workflow for branching and releases.
• Conventional Commits for commit messages.

Thank you for helping us improve Green Ecolution! 🌿