README.md

April 26, 2021 ยท View on GitHub

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

NameDescription
packages/app[Archived] First version of HappyPlants. No further development.
packages/app-nextSecond release (v2) of HappyPlants and current focus of development.
packages/firebaseServerless functions for Firebase, used for various automated tasks.
packages/landingLanding page for HappyPlants, written with Nuxt.js.
packages/serverCurrently unused.
packages/stylesGlobal, shared styles across all projects.

License

BSD 3-Clause