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:
Quick Start Guide ๐
To quickly run the application locally:
- Download the Docker Compose configuration:
wget https://raw.githubusercontent.com/green-ecolution/backend/refs/heads/develop/.docker/docker-compose.yaml
- 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 โ๏ธ
Local Development Setup ๐ป
For a detailed step-by-step guide on setting up your local development environment, refer to the Local Development Wiki ๐.
Prerequisites
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:
- Fork this repository.
- Create a topic branch off develop.
- Commit your changes.
- Push your branch to your fork.
- Open a Pull Request.
This project follows:
Thank you for helping us improve Green Ecolution! ๐ฟ