Skip to content

Latest commit

 

History

History
118 lines (102 loc) · 5.53 KB

README.md

File metadata and controls

118 lines (102 loc) · 5.53 KB
Raw

Pantry

The food awareness and tracking application designed to support planning from production to consumer

According to the national nonprofit ReFed, 35% of food per year is not sold or eaten, and that while 11% makes it to donation or recycle purposes, a whopping 54 tons (24%!) is completed unused and wasted.

How does Pantry help solve this?

Pantry is a solution dedicated at improving food waste tracking, donation awareness, and informatics for every level of the food supply chain: from producer to retailer to consumer.

The Motivation

The United Nations has 17 Sustainability goals for our planet. #12 is Ensure sustainable consumption and production patterns. According to the U.N., "Sustainable consumption and production is about promoting resource and energy efficiency, sustainable infrastructure, and providing Its implementation helps to achieve overall development plans, reduce future economic, environmental and social costs, strengthen economic competitiveness and reduce poverty."

The U.N. further lays out indicators and targets to achieve this goal:

  • Target 12.3: Halve global per capita food waste
  • Target 12.5: Substantially reduce waste generation
  • Target 12.6: Encourage companies to adopt sustainable practices and sustainability reporting
  • Target 12.8: Promote universal understanding of sustainable lifestyles

Get the application up and running!

Install Rails:

  • Rails 7.0.1
  • Ruby ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin20]
  • Node v17.4.0

Install the gems

bundle install

Create the db

bundle exec rails db:create

Seed that db

bundle exec rails db:seed

Start the app

bundle exec rails s

Access the Rails console

bundle exec rails c

If you're running this locally:

You have some users: username: basic@test.com password: tester

username: producer@test.com password: tester

Now, I do not have barcodes or qr codes for you, but I do have 10 orders, ids 1-10 that you can enter into the field on the add food page. You could also generate a qr code or bar code easily with one number 1-10 and scan the code to see that funcitonality.

The producer views are still in the works:) But you can see all your batches, choose one batch, edit that batch (and update the foor recall).

.

Postman

Producer

Producer sends the batch. Batches 1-4 are premade in the db for you. To see these batches, in console, bundle exec rails c - here is an example batch you can send through: POST to url: http://localhost:3000/api/v1/batches.json

{
  "batch": {
    "producer_id": 1,
    "item_name": "Canned Beans",
    "best_by":"2022-01-01T00:00:00.000Z",
    "exp_date":"2022-02-01T00:00:00.000Z"
    }
}

Retailer

The retailer or store sends over the order when a customer makes a purchase POST to url: http://localhost:3000/api/v1/orders.json

{
  "order": {
    "store_id": 1,
    "food_items_attributes":[{
        "batch_id": 1
        },
        {
        "batch_id": 2
        },
        {
        "batch_id": 3
        },
        {
        "batch_id": 4
        }]
    }
}

Contribution Workflow

All work is written in a feature branch off of beta and submitted as a pull request pointing to beta Before doing work, please message René at renecapella.dev@gmail.com to be added a contributor.

  1. git checkout main
  2. git pull
  3. git checkout beta
  4. git pull
  5. git checkout -b PANTRY-<issue number>
  6. Write your amazing code, make sure it passes lighthouse accessibility tests, make sure tests are passing, clean up debug and: git add, git commit -m "PANTRY-<issue number> My detailed commit message here", git push
  7. Open a pull request
  8. Assign René to code review, add a detailed explanation of how test your feature, point to beta.

Future

Pantry is off to a great start, and I have several ideas I think will take this product to the next level.

  • push notifications for when food is marked as recalled
  • machine learning to help generate purchasing and planning for producers, retailers and consumers
  • Google cloud deployment for the machine learning, security and scalability

The Team

Pantry was born out of multiple brainstorming and research iterations while finding a solution that could be simple but impactful. René Capella lead the sessions, planning. René also designed and implemented the rails application.

The project was followed closely by Khalid who provided constant design feedback and encouragement. All progress was posted to a public discord community where members were encouraged to oversee and offer thoughts and impressions. A HUGE THANK YOU is due to all the members of the Google Developer Student Club at North Seattle College for the support and feedback.

The project was overseen by Bill Barry, the Computer Science Full-time faculty and Deptartment Coordinator at North Seattle College.