/happy-plants

🌵 Web application to manage plants

Primary LanguageVueBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

HappyPlants 🌵🌱

📱 Application🌍 Website🗓 Roadmap🐛 Issues

Current version: 1.7.3

Maintenance PRs Welcome

🌱 About

HappyPlants is all about collecting, organising, and adding all kinds of information of your little friends. How much water does it need? During which seasons does it grow? When is it dormant? Does it require lots of sun? Basically, creating your own plant database in a visual way. You can either save HappyPlants to your homescreens on mobile devices (recommended) or add it to your bookmarks on desktop. This is a mobile-first web application.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior.

🔜 Version 2

HappyPlants is currently being rewritten for a new major release with more features and better application architecture. The progress can be found in packages/app-next-alt. The first release candidate is currently planned for Q2 2021. You can follow the progress on the v2 project board.

✨ Features

HappyPlants App

  • 🔋 Save all data either locally on device (via IndexedDB) or in the cloud (Firebase)
    • 🗝 Sign in options: Twitter, GitHub, Google
  • 📦 Import/Export your plant data
  • 📦 Migrate your data from local storage to Firebase and vice versa
  • 📱 Responsive layout with mobile-first focus
  • 💡 Dark/Light Theme
  • 🗂 Add, delete, modify your plants
  • 🔖 Add tags to your plants for better organisation

Add different modules to each plant

  • 💦 Watering schedule
  • ☀️ Sunshine requirements
  • 🌱 Growth cycle
  • 📝 Notes
  • 🖼 Gallery

👩🏻‍💻 Development

This repository is organised with Lerna. Detailed development documentation can be found in each packages README.

Packages

Name Description
packages/app [Archived] First version of HappyPlants. No further development.
packages/app-next Second release (v2) of HappyPlants and current focus of development.
packages/firebase Serverless functions for Firebase, used for various automated tasks.
packages/landing Landing page for HappyPlants, written with Nuxt.js.
packages/server Currently unused.
packages/styles Global, shared styles across all projects.

License

BSD 3-Clause