Skip to content

A Full Stack website utilizing Node.js, Express/PostgreSQL, Sequelize, Materialize, and Trefle's global plants API for users in explore, research, and manage their plants.

Notifications You must be signed in to change notification settings

xlnl/greenery-app

Repository files navigation

Greenery

App Demo: Pending!


Context:

Inspired by Scotts Miracle Gro My Garden App, which is centered on a digital transformation project for one of my American University's MS Analytics foundational courses, Greenery will provide users the ability to explore and add plants, specifically plants native to their area, to their virtual garden.

The intention is for users to be inspired to research how to successfully grow plants in a sustainable, bee-friendly way with a virtual garden dashboard catered to delivering necessary information all within the palm of their hands.


Wireframes

Click here to view the wireframes of Greenery

ERD

Click here to view the entity-relationship diagram of Greenery.

User Stories

  1. As a user, I want to be able to search for plants in general and within my distribution zone.
  2. As a user, I want to be able to read more details about a specific plant, including its growth descriptions and picture.
  3. As a user, I want to be able to save the plant and store it in my virtual garden.
  4. As a user, I want to be able to write notes about my saved plants to reflect on its growth progress.
  5. (Stretch) As a user, I want to be able to further keep track of plant's growth progress through a tracking form.
  6. (Stretch) As a user, I want to be able to see data visualizations of my plant's growth process based on my progress tracker.
  7. (Stretch) As a user, I want to be able to have a settings page so I can update my account information.

Approach

I took inspiration from an app that my group is working on enhancing with AR capabilities for a grad class. I wanted to combine beautiful, user-friendly design with easy functionality. This inspiration was further solidified by my encounter of the beautiful global plants API, Trefle.

I also really want to refresh my skills with PostgreSQL and get back to the basics with SQL! My hope is to scale this up and perhaps refactor to a MERN stack once I gain more fluency in developing overall.


Unsolved Problems

TBD


Technologies Used

  • Whimsicle for ERD
  • Figma for wireframing
  • VS Code Text Editor + Node.js + Express + Postgres + Sequelize + Bootstrap/CSS + Javascript + HTML

How to set up from starter code/boilerplate:

  1. Fork & clone this repo

  2. Install dependencies

npm i
  1. create a config.json with the following code:
{
  "development": {
    "database": "<insert develop db name here>",
    "host": "127.0.0.1",
    "dialect": "postgres"
  },
  "test": {
    "database": "<insert test db name here>",
    "host": "127.0.0.1",
    "dialect": "postgres"
  },
  "production": {
    "database": "<insert production db name here>",
    "host": "127.0.0.1",
    "dialect": "postgres"
  }
}

Note: If your database requires a username and password, you'll need to include these as well.

  1. Create database
sequelize db:create <insert db name here>
  1. Migrate the models to your database
sequelize db:migrate
  1. Add SESSION_SECRET and PORT environment variables in a .env file (can be any string). If planning to use a maps API, make sure you put that as an environment variable as well.

About

A Full Stack website utilizing Node.js, Express/PostgreSQL, Sequelize, Materialize, and Trefle's global plants API for users in explore, research, and manage their plants.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages