Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 4.26 KB

README.md

File metadata and controls

81 lines (55 loc) · 4.26 KB
Raw

Authors

Meghan Domeck - GitHub || LinkedIn
Hexx King - GitHub || LinkedIn
David Dicken - GitHub || LinkedIn
Tia Low - Github || LinkedIn

Version

1.0.2

Deployed

gardener-guide.herokuapp.com

Overview

  • A gardener's guide and helpful tool for gardeners and plant enthusiasts of any level
  • Unique user experience with login abilities
  • Search for a plant to find growing details such as when to plant, spacing, harvesting, etc
  • Save plants to your own "greenhouse" collection in order to be able to access them later
  • For each plant saved in your greenhouse collection, you can add, update, and delete notes
  • Utilizes RESTful API for plant resource
  • Utilizes RESTful API for weather temperature

Feature Details

Login page

Login: user enters their email. If they have already visited the page, they will be remembered and will see the home search page next (as well as find their greenhouse collection and notes from previous logins). If they have not visited before, they'll be prompted to enter the information below.

New user page

New user: user is prompted to enter their name and zip code. Zip code is used to gather weather temperature information for their location and their profile will be remembered for next time.

Search page

Homepage / search: user can search for the desired plant. If the plant is already in the database, the results page will be returned as below. If not, user will have the opportunity to complete the fields to add the plant manually to their greenhouse collection.

Result page

Results: the results of the plant search will be returned with several different pieces of information. User has the opportunity to 'Add to Greenhouse' which will save the plant to the specific user's login profile and allow them to enter notes about it later, if desired. User can also return to homepage for another search.

Create a plant page

Create a plant: if the searched plant does not already exist in the database, the user has the option to manually complete the fields to save to their greenhouse collection.

Greenhouse collection page

Greenhouse: this is the user's personalized collection of plants. On this page the user can see the temperature at their location. From here the user has the option to remove the plant from their greenhouse, or click the plant name to take them to the following details page.

Notes page

Plant details and notes: user can again see the description and image of the plant, with the option to expand to see the other plant details. User can also add their own notes about their experience with the plant, as they see fit. Once a note is added, it is saved to the user's specific profile for them to always be able to access. They can delete notes, add notes, and edit existing ones.

Getting Started

  • .env file using envSamples as a template
  • npm install the following:
    • dotenv
    • ejs
    • express
    • method-override
    • superagent
  • create database named plants using postgres
  • connect the schema file with the database

Architecture

  • HTML, CSS, JavaScript, jQuery, SQL, ejs
  • Express server

Resources: