<commit_before><h1 align="center">
  Happy Plants 🌵🌱
</h1>

<p align="center">
  Current version: <code>1.0.0-alpha</code>
</p>

<p align="center">
  <a href="https://travis-ci.com/morkro/happy-plants">
    <img src="https://travis-ci.com/morkro/happy-plants.svg?token=jraMM7KwaR9EEq8wiKZk&branch=master)" alt="Build Status" />
    <img src="https://img.shields.io/maintenance/yes/2017.svg" alt="Maintenance" />
  </a>
</p>

---

_Happy Plants_ is a mobile-first, progressive web application which helps organising and keeping track of your plants. See the list of [features](#features) for more information.

#### Usage
_Happy Plants_ is available at [happy-plans.netlify.com](https://happy-plans.netlify.com). You can either add it to your bookmarks on desktop, or save it to your homescreens on mobile devices.

- [About](#about)
- [Features](#features)
- [Data structure](#data-structure)
- [Development](#development)

---

## 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.

**_Happy Plants_ is all about organising, collecting all sorts of information and trivia, and adding notes on your little friends.** Basically, creating your own plant database.

## Features
This project is currently still very early in development right now and only supports a bare minimum set of features.

#### Adding plants
Add a name and photo to your plant. This can always be updated in the detailed plant view.

#### Overview
An overview of all your plants. Currently, you can only filter them by date or name.

#### Detailed plant profile
- Maintain a growth calendar to know if your plant is currently in a growth or dormant phase.
- Add notes.

### Planned features
Keeping track of planned features here. This is the minimum of features to move the project out of `alpha` state.

- Integrate Firebase.
- Add more basic information (scientific name, location of your plant, pruning, how much sun, ...) to plants.
- Add gallery.
- Create custom categories and sorting in overview.
- Highlight specific plants in overview.

## Data structure
In the application settings, you can download all your plant data and as well as importing data. If you want to create the plant data yourself, it has to be a valid JSON array/object structured as follows:

```
[
  {
    "guid": String,
    "created": Date,
    "modified": Date,
    "blob": Blob|base64,
    "name": String,
    "seasons": [
      {
        "month": String,
        "growth": Boolean
      }
    ],
    "notes": String,
    "watering": {
      "level": Number
    },
    "sun": {
      "intensity": Number
    }
  }
]
```

- `watering.level`: Can range from `1` to `3`.
- `sun.grade`: Can range from `1` to `3`.
- `seasons`: Should be an array containing each month.
  - If the plant is in a growth phase during that month, set `growth` to `true`.

## Development
This project supports Yarn, so you can either use `yarn` or `npm` to run tasks.

| Command | Description |
| ------- | ----------- |
| `yarn` / `npm install` | Installs dependencies |
| `yarn/npm run dev` | Serve with hot reload at localhost:8080 |
| `yarn/npm run build` | Build for production with minification |<commit_msg>:memo: (data) Updated data structure in README<commit_after><h1 align="center">
  Happy Plants 🌵🌱
</h1>

<p align="center">
  Current version: <code>1.0.0-alpha</code>
</p>

<p align="center">
  <a href="https://travis-ci.com/morkro/happy-plants">
    <img src="https://travis-ci.com/morkro/happy-plants.svg?token=<PASSWORD>&branch=master)" alt="Build Status" />
    <img src="https://img.shields.io/maintenance/yes/2017.svg" alt="Maintenance" />
  </a>
</p>

---

_Happy Plants_ is a mobile-first, progressive web application which helps organising and keeping track of your plants. See the list of [features](#features) for more information.

#### Usage
_Happy Plants_ is available at [happy-plans.netlify.com](https://happy-plans.netlify.com). You can either add it to your bookmarks on desktop, or save it to your homescreens on mobile devices.

- [About](#about)
- [Features](#features)
- [Data structure](#data-structure)
- [Development](#development)

---

## 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.

**_Happy Plants_ is all about organising, collecting all sorts of information and trivia, and adding notes on your little friends.** Basically, creating your own plant database.

## Features
This project is currently still very early in development right now and only supports a bare minimum set of features.

#### Adding plants
Add a name and photo to your plant. This can always be updated in the detailed plant view.

#### Overview
An overview of all your plants. Currently, you can only filter them by date or name.

#### Detailed plant profile
- Maintain a growth calendar to know if your plant is currently in a growth or dormant phase.
- Add notes.

### Planned features
Keeping track of planned features here. This is the minimum of features to move the project out of `alpha` state.

- Integrate Firebase.
- Add more basic information (scientific name, location of your plant, pruning, how much sun, ...) to plants.
- Add gallery.
- Create custom categories and sorting in overview.
- Highlight specific plants in overview.

## Data structure
In the application settings, you can download all your plant data and as well as importing data. If you want to create the plant data yourself, it has to be a valid JSON array/object structured as follows:

```
[
  {
    "guid": String,
    "created": Date,
    "modified": Date,
    "blob": Blob|base64,
    "name": String,
    "seasons": [
      {
        "month": String,
        "growth": Boolean
      }
    ],
    "notes": String,
    "watering": {
      "level": Number
    },
    "sunshine": {
      "intensity": Number
    }
  }
]
```

- `watering.level`: Can range from `1` to `3`.
- `sunshine.intensity`: Can range from `1` to `3`.
- `seasons`: Should be an array containing each month.
  - If the plant is in a growth phase during that month, set `growth` to `true`.

## Development
This project supports Yarn, so you can either use `yarn` or `npm` to run tasks.

| Command | Description |
| ------- | ----------- |
| `yarn` / `npm install` | Installs dependencies |
| `yarn/npm run dev` | Serve with hot reload at localhost:8080 |
| `yarn/npm run build` | Build for production with minification |
{'fraction_non_alphanumeric': 0.11612707098343213, 'fraction_numerical': 0.006231950144398844, 'mean_word_length': 3.55994455994456, 'pattern_counts': {'":': 26, '<': 28, '<?xml version=': 0, '>': 28, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 7, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2783594', 'n_tokens_mistral': 1995, 'n_tokens_neox': 1867, 'n_words': 826}