Eric Hierholzer commited on
Commit
f2b8255
Β·
1 Parent(s): c3e681b
Files changed (1) hide show
  1. README.md +9 -12
README.md CHANGED
@@ -19,7 +19,9 @@ A Flask-based web application that provides personalized recommendations for Net
19
  - Content-based recommendations based on TF-IDF and cosine similarity
20
  - Search and autocomplete functionality
21
  - Visualizations of Netflix content distribution
22
- - Works on both macOS and Windows
 
 
23
 
24
  ## Prerequisites
25
  Ensure you have the following installed:
@@ -84,20 +86,15 @@ The app will be available at:
84
  Access app at [http://0.0.0.0:7860] or [http://localhost:7860]
85
 
86
 
87
- ## Frontend Development
88
- If making changes to the frontend, ensure Node.js dependencies are installed. Run:
89
-
90
- ```sh
91
- npm run dev
92
- ```
93
-
94
  ## File Structure
95
 
96
  ```
97
- flick_picker/
 
 
98
  │── recommend_app.py # Flask API entry point
99
- │── recommendation_engine.py # Content-based filtering logic
100
- │── netflix_titles.csv # Dataset file
101
  │── requirements.txt # Python dependencies
102
  │── package.json # Frontend dependencies
103
  │── static/
@@ -121,7 +118,7 @@ deactivate
121
  ```sh
122
  venv\Scripts\deactivate
123
  ```
124
- #### DOCKER Deployment (EASY MODE)
125
 
126
  ```sh
127
  docker build -t my-recommend-app .
 
19
  - Content-based recommendations based on TF-IDF and cosine similarity
20
  - Search and autocomplete functionality
21
  - Visualizations of Netflix content distribution
22
+ - Deployed on huggingface for easiest access
23
+ - Works on both macOS and Windows locally
24
+ - Docker deployment available
25
 
26
  ## Prerequisites
27
  Ensure you have the following installed:
 
86
  Access app at [http://0.0.0.0:7860] or [http://localhost:7860]
87
 
88
 
 
 
 
 
 
 
 
89
  ## File Structure
90
 
91
  ```
92
+ finalcapstone/
93
+ │── Dockerfile # For huggingface or local easy deployment
94
+ │── README.md # Info and instructions on how to build and run
95
  │── recommend_app.py # Flask API entry point
96
+ │── recommendation_engine.py # Machine Learning Recommendation Engine
97
+ │── netflix_titles.csv # Dataset file from Kaggle.com
98
  │── requirements.txt # Python dependencies
99
  │── package.json # Frontend dependencies
100
  │── static/
 
118
  ```sh
119
  venv\Scripts\deactivate
120
  ```
121
+ ## DOCKER Deployment (EASY local deployment using Docker)
122
 
123
  ```sh
124
  docker build -t my-recommend-app .