Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adam-robson/pantrypal
This is Pantry Pal. This is the Group 6 repository from COLAB19 in 2023. It publishes at the address below.
https://github.com/adam-robson/pantrypal
Last synced: 12 days ago
JSON representation
This is Pantry Pal. This is the Group 6 repository from COLAB19 in 2023. It publishes at the address below.
- Host: GitHub
- URL: https://github.com/adam-robson/pantrypal
- Owner: Adam-Robson
- Created: 2023-05-16T19:06:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-18T10:53:53.000Z (14 days ago)
- Last Synced: 2024-12-18T11:43:33.379Z (14 days ago)
- Language: JavaScript
- Homepage: https://pantry-pal-colab.herokuapp.com/
- Size: 41.3 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pantry Pal
## Table of Contents
- [Pantry Pal](#pantry-pal)
- [Table of Contents](#table-of-contents)
- [Description](#description)
- [Overview](#overview)
- [Tech Stack](#tech-stack)
- [Features](#features)
- [Setup](#setup)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
- [MIT License](#mit-license)
## Description
This project was built as part of the Co.Lab 19 Cohort in 2023. The main goal of our group - which included George Ceja, Robert Adkins, Joel Yap and Adam Robson - when we started out, was to create an application that would make an impact in some way, on communities that were underserved. After some group brainstorming, we decided to focus on first-generation college students. In the end, we created an application that can serve any person who is in need of food assistance.
## Overview
The project consists of a MongoDB database, complete with a scraping engine built in Python that is used to source data regarding 2500 food pantries across the United States. The information is fed to MongoDB and then sent to the Python backend, which is hosted on Fly.io. The React client, hosted on Heroku, calls the backend in its fetch calls, when a user location is provided, giving the platform a city to map the food-pantries from. As a user, on load you consent to your location being shared and then your locaton appears on the map surrounded by the food pantries in your area. Each pantry is clickable leading to a detail page with information specific to that pantry, which is also provided by that pantry. You can visit the pantry's social media if it is provided, and you can look up a route to get to the pantry as well.
## Tech Stack
Frameworks: React, Flask
Languages: JavaScript, Python
Database: MongoDB
Other: Tailwind, Google Maps, Geolocation API, GeoCoding API
Deployments hosted on:
[Fly](https://fly.io/),
[Heorku](https://www.heroku.com/), and
[MongoAtlas](https://www.mongodb.com/atlas/database)
## Features
Find pantries near you
When visiting the page the application will locate you and find pantries in your area.
Search for Pantries outside of your premise
As a user you are able to search for pantries in places outside of your area.
Directions to Pantries
As a user you are able to get directions to a pantry within the application.
Tutorial
As a new user you are able to view a tutorial that explains what the application can do.
Details Page
You can also view more details of a pantry such as hours of operation, description, social media links, and more!
Navbar
Our navbar consists of pages such as About Us, Resources, and Tutorial.
## Setup
To run this project locally, first, clone the repository:
In the root folder add an `.env`
```
#.env
REACT_APP_GOOGLE_MAPS_API_KEY=
REACT_APP_FLY_API_URL=
```
Now run:
```
npm install
npm start
```
Now visit:
## Contact
Adam Robson
George Ceja
# Acknowledgements
The data used in this project was sourced [here](https://www.foodpantries.org).
## MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.