Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/renecapella/pantry

Food waste reduction application across multiple points in the supply food chain. This is also my entry for the 2022 Solution Challenge 🎉
https://github.com/renecapella/pantry

api barcode-scanner bootstrap4 food-planner google-developer-student-club progressive-web-app rails rails7 solution-challenge sustainable-software

Last synced: about 3 hours ago
JSON representation

Food waste reduction application across multiple points in the supply food chain. This is also my entry for the 2022 Solution Challenge 🎉

Host: GitHub
URL: https://github.com/renecapella/pantry
Owner: ReneCapella
License: mit
Created: 2022-02-02T02:48:58.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-03-27T02:30:24.000Z (over 2 years ago)
Last Synced: 2024-09-21T22:32:35.025Z (3 days ago)
Topics: api, barcode-scanner, bootstrap4, food-planner, google-developer-student-club, progressive-web-app, rails, rails7, solution-challenge, sustainable-software
Language: Ruby
Homepage:
Size: 2.22 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Pantry
## The food awareness and tracking application designed to support planning from production to consumer
According to the national nonprofit [ReFed](https://refed.org/about/who-we-are/#about-us),
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](https://sdg-tracker.org/sustainable-consumption-production).
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](https://sdg-tracker.org/sustainable-consumption-production#12.3): Halve global per capita food waste
- [Target 12.5](https://sdg-tracker.org/sustainable-consumption-production#12.5): Substantially reduce waste generation
- [Target 12.6](https://sdg-tracker.org/sustainable-consumption-production#12.6): Encourage companies to adopt sustainable practices and sustainability reporting
- [Target 12.8](https://sdg-tracker.org/sustainable-consumption-production#12.8): Promote universal understanding of sustainable lifestyles

# Get the application up and running!
### Install Rails:
- [Rails 7.0.1](https://guides.rubyonrails.org/getting_started.html)
- 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: [email protected]
password: tester

username: [email protected]
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 [email protected] to be added a contributor.

1. `git checkout main`
2. `git pull`
3. `git checkout beta`
4. `git pull`
5. `git checkout -b PANTRY-`
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- 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.