[Still under "initial" development, some features may be unstable or change in the future, although database schemas should be stable. 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.
Why? • Features highlights • Quickstart • Contribute
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 logs the activity you are doing. This is on purpose, I strongly believe that the only one in charge of know 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 notify you about time passed since last action on them.
- Add existing plants using Trefle API 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 reminder for some actions on your plants (e.g. notify if not watered every 4 days)
Take a look at the roadmap for a more detailed list of future features and enhancements.
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 the following files:
docker-compose.yml:
version: "3" name: plant-it services: backend: image: msdeluise/plant-it-backend:latest env_file: backend.env depends_on: - db - cache restart: unless-stopped volumes: - "./upload-dir:/upload-dir" - "certs:/certificates" ports: - "8080:8080" db: image: mysql:8.0 restart: always env_file: backend.env volumes: - "./db:/var/lib/mysql" cache: image: redis:7.2.1 restart: always frontend: image: msdeluise/plant-it-frontend:latest env_file: frontend.env links: - backend ports: - "3000:3000" volumes: - "certs:/certificates" volumes: certs: driver: local driver_opts: type: none o: bind device: ./certificates
backend.env:
# # DB # MYSQL_HOST=db MYSQL_PORT=3306 MYSQL_USERNAME=root MYSQL_PSW=root MYSQL_ROOT_PASSWORD=root MYSQL_DATABASE=bootdb # # JWT # JWT_SECRET=putTheSecretHere JWT_EXP=1 # # Server config # USERS_LIMIT=-1 UPLOAD_DIR=/upload-dir API_PORT=8080 TREFLE_KEY= ALLOWED_ORIGINS=* LOG_LEVEL=DEBUG UPDATE_EXISTING=false # # Cache # CACHE_TTL=86400 CACHE_HOST=cache CACHE_PORT=6379 # # SSL # SSL_ENABLED=false CERTIFICATE_PATH=/certificates/
frontend.env:
PORT=3000 API_URL=http://localhost:8080/api WAIT_TIMEOUT=10000 CACHE_TTL_DAYS=7 BROWSER=none SSL_ENABLED=false CERTIFICATE_PATH=/certificates/
- Run the docker compose file (
docker compose -f docker-compose.yml up -d), then the service will be available atlocalhost:3000, while the REST API will be available atlocalhost:8080/api(localhost:8080/api/swagger-ui/index.htmlfor the documentation of them).
Take a look at the documentation in order to understand the available configurations and let the service be available even from another machine.
Feel free to contribute and help improve the repo.
You can submit any of this in the issues section of the repository. Chose the right template and then fill the required info.
Let's discuss first possible solutions for the development before start working on that, please open a feature request issue.
If you want to make some changes and test them locally take a look at the documentation.
If you find this project helpful and would like to supporting it, consider by buying me a coffee. Your generosity helps keep this project alive and ensures its continued development and improvement.