Skip to content

Commit

Permalink
📝 Updating README, CHANGELOG, and version
Browse files Browse the repository at this point in the history
  • Loading branch information
@morkro
morkro committed Jan 9, 2019
1 parent 47e21cc commit 4553d52
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 146 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ All notable changes to this project will be documented here.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [1.6.0] - 2019-01-xx

## Added
- Gallery module for plants.

## Changed
- Couple of layout adjustments for the desktop version.

## Fixed
- Some minor layout issues in Plant screen

## [1.5.1] - 2018-11-10

### Added
Expand Down
174 changes: 28 additions & 146 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
</h1>

<p align="center">
Current version: <code>1.5.1</code> <a href="CHANGELOG.md">(Changelog)</a>
Current version: <code>1.6.0</code> <a href="CHANGELOG.md">(Changelog)</a>
</p>

<p align="center">
<img src="https://img.shields.io/maintenance/yes/2018.svg" alt="Maintenance" />
<img src="https://img.shields.io/maintenance/yes/2019.svg" alt="Maintenance" />
<a href="http://makeapullrequest.com" target="_blank">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome" />
</a>
Expand All @@ -17,174 +17,56 @@

<img src="resources/web-app.png" align="left" width="180px" alt="HappyPlants App" />

[_HappyPlants_](https://happyplants.garden) is all about 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.
[_HappyPlants_](https://happyplants.garden) 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, progressive web application.

This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior.

- [🌵 About](#about)
- [✨ Features](#features)
- [🎛 Data structure](#data-structure)
- [⌨️ Development](#development)
- [🎉 Credits](#credits)

---

## About
If your hobby is collecting (and growing) plants, you maybe also like to gather all the information about them and keep an organised overview about your little home garden.
## ✨ Features

_HappyPlants_ is a mobile-first, progressive web application which helps organising and keeping track of your plants.
For upcoming features, ideas, and general roadmap, see the [Roadmap board](https://github.com/morkro/happy-plants/projects/5).

## Features
This project is currently still in `alpha` development and only supports a bare minimum set of features.
Overview of all available features:

### Planned
**General**
- 🔋 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
- 💡 Dark/Light Theme
- 📱 Responsive layout with mobile-first focus

| Feature | Status |
| ------- | ------ |
| Firebase integration | ✅ Implemented |
| Better onboarding | ✅ Implemented |
| Skeleton views | ✅ Implemented |
| Growth progress gallery | Not started |
| Desktop layout | Not started |
**Plants**
- 🗂 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

### Overview page

| Feature | Description |
| ------- | ----------- |
| View mode | Choose between grid and list view. |
| Order by | The overview can be sorted by date (latest first) and alphabetical. |
| Filter | Filter view by tags. |

### Add plant

| Feature | Description |
| ------- | ----------- |
| Name and photo | Add a name and upload an additional, optional photo of the plant. |

### Plant profile

| Feature | Description |
| ------- | ----------- |
| Edit basic data | Edit your plants name or photo. |
| Add tags | / |
| Manage modules | Add/remove plant modules |
| Watering module | Manage the required watering of a plant. |
| Sunshine module | Manage the amount of sunlight the plant needs. |
| Seasons module | Lets you define the seasons in which a plant is in growth/ dormant. |
| Notes | Add notes to a plant. |
| Delete plant | Deletes your plant. |

### Settings

| Feature | Description |
| ------- | ----------- |
| Tags | Delete or rename tags. |
| Import/export | Import or export plant data. |
| Delete all | Delete all plant data. This is permanent and lost data can't be restored. |

## Data structure
In the application settings, you can download and import your plant data.

### Basic plant data
This is the minimum required data of a single plant. If you want to import the data, it should be an Array of objects.

```typescript
{
"guid": String, // [required] A random, version 4 GUID
"created": Date, // [required] Date when the plant has been created
"modified": Date, // [required] Date when plant has been modified, defaults to created date
"name": String, // [required] Name of the plant
"blob": Blob | Base64 | undefined, // [optional] A base64 encoded or Blob of the plant photo
"modules": Array<PlantModule> // [optional] Array of plant modules, should default to []
}
```

### Tag data
A plant can be assigned to various, user created, tags. A tag object should be defined as follows:

```typescript
{
"guid": String, // [required] A random, version 4 GUID
"created": Date, // [required] Date when the plant has been created
"modified": Date, // [required] Date when plant has been modified, defaults to created date
"name": String, // [required] Identifier name of the tag
"label": String, [required]
"plants": Array<guid> // [required] A list of plants associated with the tag
}
```

### Plant Modules
Modules have all the same structure with a module-specific `value` definition.

#### Watering module

```typescript
{
"type": "watering",
"value": {
"amount": 1 | 2 | 3,
"frequency": String
}
}
```

#### Sunshine module

```typescript
{
"type": "sunshine",
"value": {
"insensity": 1 | 2 | 3
}
}
```

#### Seasons module

```typescript
{
"type": "seasons",
"value": {
"seasons": [
{
"month": "January",
"growth": Boolean
},
...
]
}
}
```

#### Notes module

```typescript
{
"type": "notes",
"value": {
"notes": String
}
}
```

## Development
## ⌨️ Development
This is a Vue.js progressive web application, developed with [`@vue/cli`](https://github.com/vuejs/vue-cli).

| Command | Description |
| ------- | ----------- |
| `npm install` | Installs dependencies |
| `npm run serve` | Serve with hot reload at localhost:8080 |
| `npm run build` | Build for production with minification |
| `npm run build --report` | Build for production and view the bundle analyzer report |
| `npm run unit` | Run unit tests |
| `npm test` | Run all tests |
| `npm lint` | Runs `Standard` over all `.js` and `.vue` files |

This is an Vue.js progressive web application, developed with [`@vue/cli`](https://github.com/vuejs/vue-cli).
| `npm test:unit` | Run all unit tests |
| `npm lint` | Runs `standard` over all `.js` and `.vue` files |
| `npm lint:style` | Uses Stylelint to lint all CSS |

[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

## Credits
## 🎉 Credits
### Logo
The logo is a combination of existing illustrations by [Vitaly Gorbachev](https://www.flaticon.com/authors/vitaly-gorbachev) and [Freepik](https://www.flaticon.com/authors/freepik).

Expand Down

0 comments on commit 4553d52

Please sign in to comment.