Skip to content

MDeLuise/plant-it

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Plant-it

[Project under "active" development, some features may be unstable or change in the future. A first release version is planned to be packed soon].

Plant-it is a self-hosted gardening companion app.
Useful for keeping track of plant care, receiving notifications about when to water plants, uploading plant images, and more.

Explore the documentation

Why? • Features highlights • Quickstart • Support • Contribute

Why?

Plant-it is a gardening companion app that helps you take care of your plants.

It does not recommend you about which action to take, instead it is designed to log the activity you are doing. This is on purpose, I strongly believe that the only one in charge of knowing when to water your plants, when to fertilize them, etc. is you (with the help of multiple online sources).

Plant-it helps you remember the last time you did a treatment of your plants, which plants you have, collects photos of your plants, and notifies you about the time passed since the last action on them.

Features highlight

  • Add existing plants or user created plants to your collection
  • Log events like watering, fertilizing, biostimulating, etc. for your plants
  • View all the logged events, filtering by plant and event type
  • Upload photos of your plants
  • Set reminders for some actions on your plants (e.g. notify if not watered every 4 days)

Quickstart

Server

Installing Plant-it is pretty straight forward, in order to do so follow these steps:

  • Create a folder where you want to place all Plant-it related files.
  • Inside that folder, create a file named docker-compose.yml with this content:
    name: plant-it
    services:
      server:
        image: msdeluise/plant-it-server:latest
        env_file: server.env
        depends_on:
          - db
          - cache
        restart: unless-stopped
        volumes:
          - "./upload-dir:/upload-dir"
        ports:
          - "8080:8080"
          - "3000:3000"
    
      db:
        image: mysql:8.0
        restart: always
        env_file: server.env
        volumes:
          - "./db:/var/lib/mysql"
    
      cache:
        image: redis:7.2.1
        restart: always
  • Inside that folder, create a file named server.env with this content:
    #
    # DB
    #
    MYSQL_HOST=db
    MYSQL_PORT=3306
    MYSQL_USERNAME=root
    MYSQL_PSW=root
    MYSQL_DATABASE=bootdb
    MYSQL_ROOT_PASSWORD=root
    
    #
    # JWT
    #
    JWT_SECRET=putTheSecretHere
    JWT_EXP=1
    
    #
    # Server config
    #
    USERS_LIMIT=-1
    UPLOAD_DIR=/upload-dir
    API_PORT=8080
    FLORACODEX_KEY=
    LOG_LEVEL=DEBUG
    ALLOWED_ORIGINS=*
    
    #
    # Cache
    #
    CACHE_TTL=86400
    CACHE_HOST=cache
    CACHE_PORT=6379
  • Run the docker compose file (docker compose -f docker-compose.yml up -d), then the service will be available at localhost:3000, while the REST API will be available at localhost:8080/api (localhost:8080/api/swagger-ui/index.html for the documentation of them).

Take a look at the documentation in order to understand the available configurations.

App

You can access the Plant-it service using the web app at http://<server_ip>:3000.

For Android users, the app is also available as an APK, which can be downloaded either from the GitHub releases assets or from F-Droid.

Download

  • GitHub Releases: You can download the latest APK from the GitHub releases page.

    Get it on GitHub

  • F-Droid: Alternatively, you can get the app from F-Droid.

    Get it on F-Droid

Installation

For detailed instructions on how to install and configure the app, please refer to the installation documentation.

Support the project

If you find this project helpful and would like to support it, consider buying me a coffee. Your generosity helps keep this project alive and ensures its continued development and improvement.

Contribute

Feel free to contribute and help improve the repo.

Contributing Translations to the Project

If you're interested in contributing transactions to enhance the app, you can get started by following the guide provided here. Your support and contributions are greatly appreciated.

Language Filename Translation
English app_en.arb 100%
Italian app_it.arb 100%
German app_de.arb 92%
Russian app_ru.arb 91%
Dutch Flemish app_nl.arb 91%
French app_fr.arb 90%
Danish app_da.arb 90%
Portuguese app_pt.arb 89%
Ukrainian app_uk.arb 87%
Spanish Castilian app_es.arb 87%

Bug Report, Feature Request and Question

You can submit any of this in the issues section of the repository. Choose the right template and then fill in the required info.

Feature development

Let's discuss first possible solutions for the development before start working on that, please open a feature request issue.

How to contribute

If you want to make some changes and test them locally take a look at the documentation.