Rotten Potatoes

Final Submission Docs

• Final Project Document
• SQL Schema ER Diagram
• SQL Schema File

Table of Contents

• Build Instructions
• Git Instructions
• Documents
  • Documents
  • TODO List
  • API Notes
  • SQL Notes
• Diagrams
  • ER Diagrams
  • View Diagrams
  • State Diagrams
  • UI Diagrams

---

Build Instruction

1. in working project folder directory enter in terminal/bash: npm install to downloaded all necessary dependencies

$ npm install

2. in working project folder directory enter in terminal/bash:

$ touch .env

• this will create a file where you can place your environment variables

3. open the .env file and enter in your environment variables as followed

# can be changed to a port you'll be using:
PORT=3000

# reference: https://www.omdbapi.com , *requires* api key
OMDB_API_KEY=your_api_key

# reference: https://developer.themoviedb.org, *requires* api key
TMDB_API_KEY=your_api_key
TMDB_READ_ACCESS_TOKEN=your_read_access_token_here

# DB Connection Info
DB_HOST=host_name_goes_here
DB_USER=db_username_goes_here
DB_PASSWORD=db_password_goes_here
DB_NAME=db_name_goes_here

4. if you look at the package.json file, you'll see that I've included some scripts to make some commands easier to remember, you can call them using npm run script-name for example: the call for nodemon index.js to run the server is just:

$ npm run server

5. Bootstrap has also been installed if you wish to make changes, ie customize themes etc. run these two scripts in a seperate terminal to see build changes made, and for it to watch for any changes made.

npm run build-css
npm run watch-css

6. refer to SQL Notes in order to setup your own working database via https://cloud.fastcomet.com, ensure that your .env environment variables match according to the assigned values of your newly created db.

---

Git Instructions

our feature branch will act as our ordered sandbox, where we push and pull from regularly. consider dev_branch the branch you intend to work in.

• when pushing to feature do a self check and ensure all components are working as intended, upon successful push to feature let team know via discord
• pull from feature regularly to get the most up to date code
• we'll reserve pushes to main, after full team review.

gitGraph
    commit
    branch feature
    checkout feature
    commit id: "pull from feature"
    checkout main
    merge feature
    checkout feature 
    branch dev_branch
    checkout dev_branch
    commit
    commit
    checkout feature
    merge dev_branch id: "pull & push to feature"
    checkout main
    merge feature
    checkout feature
    checkout dev_branch
    commit
    checkout feature
    branch teammate_dev_branch
    checkout teammate_dev_branch
    commit
    commit
    checkout feature
    merge teammate_dev_branch id: "push to feature from teammate_dev_branch"
    checkout dev_branch
    checkout feature
    merge dev_branch id: "push to feature from dev_branch"
    checkout main
    merge feature

    

Loading