diff --git a/README.md b/README.md index d389ac409..4764f4555 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,19 @@ - [Brief Overview of Project](#project-description) - [What Docs](#what-docs) - [How Docs](#how-docs)
- - [Recommendation Mechanism](#movie-recommendation-mechanism)
- - [Email Notifier](#email-notifier) + - [MongoDB](#mongodb-integration) + - [Docker](#docker-container) + - [Collaborative Filtering](#collaborative-filtering) + - [Streaming Links](#streaming-links) + - [Dashboard](#dashboard) - [Create an Acccount](#create-an-account) - [Login to Account](#login-to-account) - [Profile and Friends](#profile-and-friends) - [Wall](#wall) -- [Improvements Made in the Project](#project-3-delta) + - [Recommendation Mechanism](#movie-recommendation-mechanism)
+ - [Email Notifier](#email-notifier) + +- [Improvements Made in the Project](#project-2-delta) - [TechStack Used for the Development of Project](#tech-stack-used) - [Steps for Execution](#getting-started) - [Future Scope](#future-scope) @@ -70,20 +76,6 @@ View our autogenerated doco here [Doco](https://github.com/se24ncsu/PopcornPicks ## How docs -### Movie Recommendation Mechanism -#### (Modified in project 2) -**The user selects upto 5 movies to get a tailored watchlist and provide feedback for the same** - - - -### Email Notifier -**The user sends his/her movies feedback via an email (Notify Me button)** - -
- Email Notifier - Email -
- ### MongoDB integration #### NEW in project 2 **The project now uses MongoDB Atlas, which is highly scalable and fast.** @@ -129,6 +121,19 @@ View our autogenerated doco here [Doco](https://github.com/se24ncsu/PopcornPicks **The user can interact with other users, by viewing a community sourced wall of recent moview reviews** +### Movie Recommendation Mechanism +**The user selects upto 5 movies to get a tailored watchlist and provide feedback for the same** + + + +### Email Notifier +**The user sends his/her movies feedback via an email (Notify Me button)** + +
+ Email Notifier + Email +
+ ## Project 2 Delta Check out the significant changes that we made for Project 2 [here](https://github.com/se24ncsu/PopcornPicks/blob/main/proj2/Proj2Changes.md) @@ -152,6 +157,7 @@ Our grading scorecard can be found [here](https://github.com/se24ncsu/PopcornPic

+ ## Getting Started Step 1: @@ -168,8 +174,10 @@ Our grading scorecard can be found [here](https://github.com/se24ncsu/PopcornPic https://github.com/se24ncsu/PopcornPicks/blob/main/docs/install.md - OR Step 1: - Use docker image present at https://drive.google.com/file/d/14ofAh84cE1sCS8k8yHVbWzRlIa1KDRhb/view?usp=share_link and use + OR + + Step 1: + Use docker image present at [Docker Image](https://drive.google.com/file/d/14ofAh84cE1sCS8k8yHVbWzRlIa1KDRhb/view?usp=share_link) and use docker save -o popcorn.tar popcorn