https://github.com/troennes/yearly-yields

Showcase your yearly crop yields
https://github.com/troennes/yearly-yields

agriculture crop farming gardening showcase yield-farming

Last synced: 11 days ago
JSON representation

Showcase your yearly crop yields

• Host: GitHub
• URL: https://github.com/troennes/yearly-yields
• Owner: troennes
• License: mit
• Created: 2022-11-12T11:58:16.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-12T12:23:39.000Z (about 2 years ago)
• Last Synced: 2024-01-25T00:44:40.227Z (10 months ago)
• Topics: agriculture, crop, farming, gardening, showcase, yield-farming
• Language: HTML
• Homepage:
• Size: 1.49 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yearly yields

Showcase your yearly crop yields from farming or gardening.

![](screenshot.png)

## Features

- Works offline, without a webserver

- No installation required

- 90 icons included

- Add your own images

- Easy to modify

- Easy to extend

## How to use

- Add your yields data to data.js

  - name: what is it (title)

  - description: subspecies or other description (subtitle)

  - yield: amount and unit

  - type: can be "fruit", "vegetable" or "product". Berries are fruits

  - icon: filename in icons folder without .png (./icons/***fruit-apple***.png)

  - img: (optional) filename in img folder without .jpg (./img/***apple-tree-1***.jpg)

Example

```js

{

  name: "Apple",

  description: "Pink Lady",

  yield: "2.8kg",

  type: "fruit",

  icon: "fruit-apple",

  img: "apple-tree-1"

},

```

How to find icons that fit in:

1. Go to flaticon.com

2. Search using the "Lineal Color" filter

3. Download as 128x128px PNG file

4. Store it in the icons folder

## Contributing

Don't be afraid to contribute! For now, create an issue if you see room for improvement, and we'll take it from there.