Skip to content

Commit

Permalink
Merge pull request #53 from se24ncsu/urls
Browse files Browse the repository at this point in the history
Updates on Docs
  • Loading branch information
akuldevali authored Nov 2, 2024
2 parents a65b8bc + a9427cc commit e670df8
Show file tree
Hide file tree
Showing 9 changed files with 118 additions and 12 deletions.
51 changes: 43 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
## Why use PopcornPicks?

<img
src="https://giphy.com/gifs/movie-cinema-popcorn-tmH5eUto7WumOdTvRG"
src="https://www.wlns.com/wp-content/uploads/sites/50/2020/01/popcorn-1085072_1920_29563194_ver1.0.jpg?strip=1"
alt="Movie Time"
width="40%"
width="30%"
align="right"
/>

Expand All @@ -52,8 +52,7 @@ Checkout for project documentation [here](https://github.com/se24ncsu/PopcornPic

## Project Presentation Videos
### New Features 2 minute demo
[![why contribute video](https://img.youtube.com/vi/QHju8EzQUQ4/0.jpg)](https://www.youtube.com/watch?v=QHju8EzQUQ4)

[![why contribute video](https://img.youtube.com/vi/M13zDRgjNGE/0.jpg)](https://www.youtube.com/watch?v=M13zDRgjNGE)
### Why contribute?
[![why contribute video](https://img.youtube.com/vi/aQ1cryH4B7A/0.jpg)](https://www.youtube.com/watch?v=aQ1cryH4B7A)

Expand Down Expand Up @@ -85,26 +84,52 @@ View our autogenerated doco here [Doco](https://github.com/se24ncsu/PopcornPicks
<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.**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/mongo.gif" width="600" height="375">

### Docker Container
#### NEW in project 2
**The application is containerized using Docker, ensuring consistent deployment across all environments.**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/docker.gif" width="600" height="375">

### Collaborative Filtering
#### NEW in project 2
**Implements an intelligent recommendation system using collaborative filtering to suggest personalized movie choices.**

### React Components
#### NEW in project 2
**Utilizes modern React components with hooks for efficient state management and reusable UI elements.**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/react.gif" width="600" height="375">

### Streaming Links
#### NEW in project 2
**We provide streaming links directly to the appropriate website for easier access.**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/links.gif" width="600" height="375">

### Dashboard
#### NEW in project 2
**Features an analytics dashboard that displays user-related data like genres.**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/dashboard.gif" width="600" height="375">

### Create an Account
#### (NEW in project 3)
**Users can now create accounts, persisting data including their movie reviews and recommendations**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/create_account.gif" width="600" height="375">

### Login to account
#### (NEW in project 3)
**The user can log in to their account securly with encrypted passwords stored in our database**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/login.gif" width="600" height="375">

### Profile and Friends
#### (NEW in project 3)
**The user can add friends, view the movies reviewed by the friends, and see their reviewed movies in their profile**
<img src="https://github.com/se24ncsu/PopcornPicks/blob/main/asset/profile.gif" width="600" height="375">

### Wall
#### (NEW in project 2)
**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">


## 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 Down Expand Up @@ -142,10 +167,20 @@ Our grading scorecard can be found [here](https://github.com/se24ncsu/PopcornPic
Follow the setup instructions in the installation documentation

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

docker save -o popcorn.tar popcorn

docker load -i popcorn.tar

docker run -d -p 3000:3000 -p 5001:5001 popcorn


<b>Finally, start enjoying personalized movie recommendations!</b>


## Future Scope
PopcornPicks is a dynamic project with endless possibilities for expansion and enhancement. Here are some exciting avenues for future development:

Expand Down
Binary file added asset/dashboard.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added asset/docker.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified asset/header_display.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added asset/header_display_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added asset/links.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added asset/mongo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added asset/react.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
79 changes: 75 additions & 4 deletions asset/system_architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e670df8

Please sign in to comment.