Skip to content

Commit

Permalink
Update install.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nathankohen authored Nov 27, 2023
1 parent db1ab5c commit 566e2d0
Showing 1 changed file with 27 additions and 13 deletions.
40 changes: 27 additions & 13 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,46 @@
# Steps for setting up the repository and running the web app

**Step 1:**
**Git Clone the Repository**
## Step 1: Git Clone the Repository

git clone https://github.com/brwali/PopcornPicks.git

(OR) Download the .zip file on your local machine from the following link

https://github.com/brwali/PopcornPicks/

**Step 2:**
**Install the required packages by running the following command in the terminal**
## Step 2: Install the required packages by running the following command in the terminal

pip install -r requirements.txt

**Step 3:**
**Run the following command in the terminal**

## Step 3: MySQL Install
Download and Install [MySQL Workbench](https://dev.mysql.com/downloads/workbench/) and [MySQL Community Server](https://dev.mysql.com/downloads/mysql/)

## Step 4: Setting up MySQL Community Server

In the `Type and Networking` tab, select config type as **Server Computer**

All other menus, use default settings. If you create a root password, be sure not to lose it!

Click `Execute` button on the bottom of the window to start the MySQL Service.

## Step 5: Setting up MySQL Workbench
1. Launch MySQL Workbench
2. Under MySQL Connections, Right click in the whitespace. Select `Rescan for Local MySQL Instances`. It should detect the server established in the previous step.
3. Select the discovered Local instance and enter your password if created in server setup.
4. Click `File` > `Open SQL Script` then select `init.sql` in the `PopcornPicks/src` directory. This will create the tables required for the application's persistence.
5. Repeat above step for `movies.sql` file located in the `PopcornPicks/src` directory. This may take a few minutes.


## Step 6: Python Packages
Run the following command in the terminal

cd src/recommenderapp
python app.py


**Step 4:**
**Open the URL in your browser:**
## Step 7: Open the URL in your browser

http://127.0.0.1:5000/

**You can also leave Steps 2-4 and directly run the setup.py file for setting up all dependencies and running the web app!**

python setup.py

**NOTE: For the email notifier feature - create a new gmail account, replace the sender_email variable with the new email and sender_password variable with its password (2 factor authentication) in the utils.py file (function: send_email_to_user(recipient_email, categorized_data)).**
**NOTE: For the email notifier feature - create a new gmail account, replace the sender_email variable with the new email and sender_password variable with its password (2 factor authentication) in the utils.py file (function: send_email_to_user(recipient_email, categorized_data)).**

0 comments on commit 566e2d0

Please sign in to comment.