Fornear

A click-and-collect solution proposal to benefit the operations of Petey's Pantry @ Oglethorpe University.

Context

Oglethorpe University is a school right outside of Atlanta, Georgia that is recognized nationally for their commitment to affordability, individualized student support, their diverse student population, and quality of academic programs. [https://oglethorpe.edu/about/]

They were also the first Georgia college to partner with TheDream.US to provide scholarships to qualified immigrant students who came to the United States as children, known as “DREAMers.” [https://oglethorpe.edu/admission/undergraduate-admission/scholarships-and-aid/dream-us-faqs/]

An on-campus organization called Petey's Pantry stores, maintains an inventory, handles requests, and distributes foodstuffs throughout the Oglethorpe community. [https://health.oglethorpe.edu/food-pantry/]

Background

Fornear is a play on "For here [or to go?]", derived from the Italian verb "Fornire", which translates to provide, or supply. Replacing "here" with "near" implies a familiar and community-based connotation.

Petey’s Pantry student workers use Microsoft Forms, Microsoft Excel, and text-communication to operate their service.

Fornear is a responsive web-app that allows users to request packages of foodstuffs, configured by staff. They set package names, what foodstuffs comprise them, and the dietary restriction(s) the package satisfies.

A package's stock is automatically reported based on the inventory's status. Staff can add, query, modify, and audit the inventory to reflect the pantry's current stock. Students can view available packages, the quantity, and which dietary restrictions each package adheres to. From there, they can request a package, along with 3 personal care products (PCPs), or a package of 7 PCPs.

Installation

This is a React/Flask project that uses MongoDB Atlas as a database. To run this project, you will need to have Node.js, Python, and MongoDB installed on your machine.

Fork the repository @ https://github.com/jibranabsarulislam/Fornear/fork
Clone the repository to your local machine

Install dependencies

Frontend:

cd frontend
npm install

Backend:

cd backend
python -m venv venv
. ./venv/bin/activate # (Non-Windows)
# OR
. ./venv/Scripts/activate # (Windows)
pip install -r requirements.txt

Create a MongoDB Atlas account and create a cluster OR run locally
- For either option, create a database and collection
  - Database: fornear-v1
  - Collection: inventory
- To run locally, python app.py --local (skip to step 6)

Create a fornear_secrets.py in backend/ with the following:

# MongoDB Atlas connection string
MONGO_URI = "mongodb+srv://<username>:<password>@<cluster>/<database>?retryWrites=true&w=majority"

Run the project

Terminal 1 - Frontend:

cd frontend
npm start

Terminal 2 - Backend:

cd backend
. ./venv/bin/activate # (Non-Windows)
# OR
. ./venv/Scripts/activate # (Windows)
flask run --reload
# OR, if you have MongoDB Community Server running locally,
python app.py --local