gardening-app

An app to help new gardeners determine what to plant in their yard.

It has been determined that Django and Render will be used to host this web app.

Quick Start

For Contributors: See CONTRIBUTING.md for setup instructions and development workflow.

For Documentation:

• Project Documentation
• Dependency Management Guide
• Makefile Guide

Common Commands:

make install       # Install dependencies
make help          # Show all available commands

Resources:

• Miro board

Requirements

Below are the requirements for this project before crafting systems requirements documentation (effectively "initial requirements" not yet fully vetted):

1. A way to show different plant information

2. A way for logged in users to choose a plant and add to their "collection"

3. Each plant will include information on the following:

   • photo
   • common name
   • scientific name
   • suggested hardiness zone (with link to USDA hardiness site)
   • plant spacing
   • plant height
   • suggested container size
   • companion plants (if any)
   • medicinal benefits (if any)
   • links to additional guides or resources mentioning this plant
   • special aging information (e.g.: germination, days to maturity, etc)

4. Each guide / resource model will contain the following:

   • URL or where can find / purchase the material
   • title
   • author(s)
   • list of plants related to this resource

Requirements Documentation

As I have been going through Cornell's System's Design certification program, I have utilized this app as the main focus for development.

As of 20250116, I have moved the original v1 into the 2024-Django-Attempt folder and will be leveraging MKDocs for the documentation instead of the GitHub project Wiki.