Beareats

Welcome to Beareats, your go-to platform for making dieting social and engaging! This application is designed to create a vibrant community of health-conscious individuals who want to share, explore, and improve their dietary habits while connecting with fellow UC Berkeley students.

Table of Contents

• Introduction
• Features
• Getting Started
  • Installation
  • Usage
• Technology Stack
• Contributing
• License

Introduction

Beareats is a unique platform that aims to foster a sense of community among UC Berkeley students who are passionate about health and wellness. With Beareats, you can share your favorite recipes, explore new meal ideas, track your macros, and connect with friends who share similar health goals.

Features

• Social Meal Sharing: Take a picture of your meal, list the ingredients, and write a short description. Beareats will calculate the nutritional information and display it alongside your post.

• Nutritional Information: Gain insights into the macro and micro nutrients of your meals. This feature helps you make informed dietary choices while engaging with the community.

• Dark Mode Accessibility: We've implemented a dark mode theme to enhance readability, reduce eye strain, and accommodate users with visual sensitivities.

• Community Engagement: Connect with fellow students who are also using Beareats. Like, comment, and engage with their posts to build a supportive community.

Getting Started

Installation

1. Clone this repository to your local machine.
2. Navigate to the project directory.
3. Make sure you have Node and npm installed.

Check to see if you can run $ node -v and $ npm -v (My versions are v16.15.0 for node and 8.10.0 for npm.)

4. Install the Express module using npm. ex: $ npm install express

5. Run the example app using Node: ex: $ node App.js

** You should see the message Server is running on http://localhost:8000

Usage

1. Run the app using your preferred development environment.
2. Sign up or log in to create your profile.
3. Explore the feed, view meal posts, and engage with the community.
4. Share your own meals, view nutritional information, and connect with friends.
5. Note: we ask you to use our app in this flow: Login -> Scroll through the hub -> click on "Amy's post" -> interact w the post (comment, like, share) -> click go to Instacart -> interact w page (add ingredients) -> go back to the hub -> make a new post (on sidebar) -> drag and drop picture add comments -> go back to hub -> new post has been created -> go to profile link -> check out rewards and interact.

Technology Stack

Beareats is built using the following technologies:

• HTML
• CSS
• JS

Contributing

We welcome contributions from the community! If you have any suggestions, bug reports, or feature requests, please feel free to open an issue or submit a pull request.

License

Beareats is licensed under the MIT License.