automated-irrigation-system

(★ 776)

This is the software of an open source automated irrigation system. The complete setup including hardware can be found in the README.

File Explorer

Download Latest Version (.zip)

- - ESP8622_moisture.ino.ino
- - www
- - irrigation-controller.js
  - measurement-controller.js
  - preference-controller.js
  - sensor-controller.js
- - irrigations.js
  - preferences.js
- - index.js
- - irrigation-service.js
  - measurement-service.js
  - preference-service.js
  - sensor-service.js
- - error.jade
- .gitignore
- app.js
- Dockerfile
- package-lock.json
- package.json
- - software-architecture.drawio
- - app-dark.png
  - app-light.png
  - hardware-architecture.png
  - software-architecture.png
- - bootstrap.css
- index.html
- logo.svg
- manifest.json
- - logo.svg
  - moon.svg
  - sun.svg
  - watering.svg
- index.js
- Main.js
- style.css
- theme.js
.dockerignore
.gitignore
docker-compose.yml
Dockerfile
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/PatrickHallek/automated-irrigation-system

Downloads the entire project code from GitHub to your computer.

cd automated-irrigation-system

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.

curl -sSL https://get.docker.com | sh

Downloads and runs the official install script in one line — this handles the full setup automatically.

sudo apt-get install -y libffi-dev libssl-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt-get install -y python3 python3-pip

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt install mongodb

Installs directly from the APT package repository (Debian/Ubuntu-based).

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

curl -sSL https://get.docker.com | sh

Downloads and runs the official install script in one line — this handles the full setup automatically.

sudo usermod -aG docker pi

Type this command into your terminal and run it.

sudo pip3 install docker-compose

Runs the command against the services defined in the compose file.

sudo nano docker-compose.yml

Runs the command against the services defined in the compose file.

sudo docker-compose up

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm -v

Type this command into your terminal and run it.

npm install

Downloads and installs the libraries listed in package.json.

npm run build

Builds optimized production files.

npm start &

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.