/noodle-n

Primary LanguageJavaScriptMIT LicenseMIT

Commitizen friendly Conventional Commits

Introduction

Noodle'n is a Full-stack web application designed to aid your individual grocery-related needs!

Mission and Objectives

Who? What? Where? When? Why?

  • Our mission is to create a grocery shopping app that allows users to efficiently track grocery supplies before, during, and after shopping.

  • Users will reduce stress related to overpacked schedules and reptile grocery purchases leading to unused products.

Project Overview

Time

  • Estimated Duration: 1 Week

Team

  • Full-Stack Developer
  • Front-end Specialist
  • Back-end Specialist
  • UX Designer and Researcher
  • Graphic Designer
  • DevOps

Problem Statement

What problem does this application solve?

  • Organizing shared resources for large families.
  • Preventing waste of money and food.
  • Maximizing visual appeal, aesthetics, and accessibility.
  • Making healthier dieting choices.
  • Fostering ecological sustainability.
  • Collaborating with food services in catering, restaurants, parents, and colleges.

Goals/Solutions

MVP

  • Create a basic app that has CRUD.

Who is this for?

Solutions

  • Parents: allow syncing of grocery items that are 1.) already in fridge and 2.) needs purchasing.
  • Restaurant: allow restaurant owners to prioritize purchases based on cost and expiration date.
  • College Students: facilitate diverse and nutritious meal planning when grocery shopping.

Future Optimizations

Full-Stack

  • Improving accessibility and support for marginalized and disabled users
  • Integrating common fitness trackers and support for wearable technologies
  • Implementing Finance and Banking API support to tailor recommendations based on budget
  • Adding a calendar feature
  • Adding auto-complete options
  • Adding search bar feature

DevOps

  • Containerizing application via Docker
  • Implementing Container Orchestration such as Kubernetes
  • Implementing Infrastructure as Code technologies such as Ansible
  • Streamlining application through a CI/CD pipeline tool such as Jenkins
  • Integrating Cloud & IaaS support
  • Implementing a robust testing framework
  • Implementing Agile workflow methodologies
  • Implementing bi-directional GitHub and Trello communication feature
  • Implementing Documentation Linting and CLI

Logistics

  • Re-framing Future Optimizations as SMART goals
  • Creating Discord server with GitHub webhook for push alerts

Packages/Dependencies used

bcrypt, connect-mongo, dotenv, ejs, express, express-flash, express-session, mongodb, mongoose, morgan, nodemon, passport, passport-local, validator, husky, commitlint, standard-version, commitizen

Install all the dependencies or node packages used for development via Terminal

npm install

Things to add

  • Create a .env file and add the following as key: value
    • PORT: 2121 (can be any port example: 3000)
    • DB_STRING: your database URI

Important Project Resources