Skip to content

Commit

Permalink
Merge pull request #54 from se24ncsu/urls
Browse files Browse the repository at this point in the history
Docker image added
  • Loading branch information
Shrimadh authored Nov 2, 2024
2 parents e670df8 + 30698e4 commit 3b86b69
Showing 1 changed file with 27 additions and 19 deletions.
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,19 @@
- [Brief Overview of Project](#project-description)
- [What Docs](#what-docs)
- [How Docs](#how-docs)<br/>
- [Recommendation Mechanism](#movie-recommendation-mechanism)<br/>
- [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)<br/>
- [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)
Expand Down Expand Up @@ -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**

<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/recommend_mechanism.gif" width="600" height="375">

### Email Notifier
**The user sends his/her movies feedback via an email (Notify Me button)**

<div style="display: flex; justify-content: space-between;">
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/email_notifier.gif" alt="Email Notifier" width="600" height="375">
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/email.png" alt="Email" width="400" height="400">
</div>

### MongoDB integration
#### NEW in project 2
**The project now uses MongoDB Atlas, which is highly scalable and fast.**
Expand Down Expand Up @@ -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**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/wall.gif" width="600" height="375">

### Movie Recommendation Mechanism
**The user selects upto 5 movies to get a tailored watchlist and provide feedback for the same**

<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/recommend_mechanism.gif" width="600" height="375">

### Email Notifier
**The user sends his/her movies feedback via an email (Notify Me button)**

<div style="display: flex; justify-content: space-between;">
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/email_notifier.gif" alt="Email Notifier" width="600" height="375">
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/email.png" alt="Email" width="400" height="400">
</div>


## 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)
Expand All @@ -152,6 +157,7 @@ Our grading scorecard can be found [here](https://github.com/se24ncsu/PopcornPic
<img src="https://media.giphy.com/media/fsEaZldNC8A1PJ3mwp/giphy.gif" width="150"/> <!-- CSS3 -->
<img src="https://media.giphy.com/media/XAxylRMCdpbEWUAvr8/giphy.gif" width="150"/> <!-- HTML5 -->
</p>

## Getting Started

Step 1:
Expand All @@ -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

Expand Down

0 comments on commit 3b86b69

Please sign in to comment.