AnupK1234 / MealMatters

MealMatters is a webapp designed to overcome student food insecurity by connecting students with nearby restaurants that provide free meals.
https://mealmatters.anupkhismatrao.xyz/
MIT License
2 stars 3 forks source link
auth0 expressjs monogodb nodejs reactjs swoc-s4 tailwindcss

MealMatters

Introduction:

MealMatters is a webapp designed to overcome student food insecurity by connecting students with nearby restaurants that provide free meals. The webapp facilitates student registration, enabling them to view a list of nearby restaurants offering free meals and request coupons from the organization. Donors can also register for an account and make donations to the organization, which utilizes these funds to reimburse restaurants for meals provided to students. MealMatters aims to increase student access to free meals, alleviate the financial burden of food insecurity, raise awareness of the issue, and encourage support for student food insecurity initiatives.

Tech Stack:

Versions Used

Configure and run on local environment

Project directory/folder structure:

Setting up project locally (Installation) :

  1. Fork the repository

  2. Clone Your Forked Repository:

git clone https://github.com/<your_username>/MealMatters.git

Client (Frontend)

  1. Navigate to the Client Directory:
cd MealMatters/client
  1. Install Dependencies:
npm install
  1. Start the Application:
npm run dev

The client will be running on http://localhost:5173/ in your browser.

Server (Backend)

  1. Navigate to the Server Directory:
cd MealMatters/server
  1. Install Dependencies:
npm install
  1. Start the server
npm start

Note : Create a .env file in the root of server directory and add the following entities in that .env file

MONGO_URL = mongodb+srv:<YOUR_MONGODB-ATLAS_CONNECTION_STRING_URL>
PORT = 5000
JWT_SECRET = <YOUR_SECRET_KEY>
SMPT_MAIL = <YOUR_SMPT_MAIL>
SMPT_PASSWORD = <YOUR_SMPT_PASSWORD>
SMPT_HOST = "smtp.gmail.com"
SMPT_PORT = "587"

Refer this image for MONGODB-ATLAS_CONNECTION_STRING_URL : Link

How to contribute 👨‍💻

Connect with Project Admin :

Anup Khismatrao

License 🛡️

MealMatters is licensed under the MIT License - see the LICENSE file for details.