snackOverflow

Get to know your colleagues while swapping and sharing snacks!

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contact
5. Acknowledgments

About The Project

snackOverflow is a web application that helps people who are returning to the office make new friendships and connections over a shared meal. Users can swap and share their food, and can leave anonymous comments on other people's posts to let them know they are interested in sharing their snack.

Developed in a day and a half for SAP's 2022 Hackathon.

(back to top)

Built With

• MongoDB
• Express
• React.js
• Node.js

(back to top)

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/christietsang/snackOverflow

2. Create a .env file in the folder backend with the information:

   NODE_ENV=development
   MONGO_DATABASE_URL=<your_mongoDB_url_here>
   SECRET=<your_json_web_token_here>

3. Install dependencies
4. Move inside the backend directory and start the server

   npm start run
   

5. In a different terminal, move inside the frontend directory and start the server

   npm start run
   

(back to top)

Roadmap

• Users can create posts for their snacks
• Data for posts persists to the database
• Develop front end framework to display data
• Implement comments section for each post
• Refresh frontend for better UX/UI
• Implement authentication system
• Add notifications for when users receive a comment on their post
• Allow users to have a personal wishlist

(back to top)

Contact

Bosco Chan

Christie Tsang

Belal Kourkmas

(back to top)

Acknowledgments

• Markdown Guide
• Tutorial on MERN stack
• React Tutorial

(back to top)