Skip to content

An application that allows a user to search for media found on the iTunes Store

Notifications You must be signed in to change notification settings

ChadProbert/media-search

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 

Repository files navigation

How To Use The App

The user can search for media by typing in a search term into the search box and clicking the 'Search 🔍' button to perform the search. The user can filter the types of media to search for by typing the search term into the search box, selecting a media radio button/s and then clicking the 'Search 🔍' button. Once the search results are displayed the user can then interact with them by clicking on any of the search results which will take the user to the website where more information can be seen, read and heard about that search result. The user can also click on the heart icon which will add that song to the user's list of favourites ❤️. The user can remove an item from their list of favourites by clicking the 'X' button next to the item in the favourites list.


Installation 📦


Downloading The Files

  1. Navigate to https://github.com/ChadProbert/media-search in the web browser.
  2. Click the green 'Code' dropdown button and click 'Download Zip'
  3. Once download is complete open the zip file and extract the contents to the desktop

🟦 Backend

  1. Open the terminal.
  2. Navigate to the backend directory (cd backend).
  3. Type 'npm install' and press 'Enter'.
  4. Wait for installation to complete.

🟩 Frontend

  1. Open the terminal.
  2. Navigate to the frontend directory (cd frontend).
  3. Type 'npm install' and press 'Enter'.
  4. Wait for installation to complete.

Running The App 💻


🟦 Start The Backend

  1. Open the terminal.
  2. Navigate to the backend directory (cd frontend).
  3. Type 'npm start' and press 'Enter'.
  4. Wait for the confirmation message "Listening on PORT 5000".

🟩 Start The Frontend

  1. Open the terminal.
  2. Navigate to the frontend directory (cd frontend).
  3. Type 'npm start' and press 'Enter'.
  4. Wait for the web browser to start or navigate to localhost:3000 inside the web browser.

Testing The App ✔️


🟦 Backend Tests

  1. Ensure that the backend is running.
  2. Open the terminal.
  3. Navigate to the backend directory (cd backend).
  4. Type 'npm test' and press 'Enter'.
  5. Wait for the tests to give a response in the terminal.

🟩 Frontend Tests

  1. Ensure that the frontend is running.
  2. Open the terminal.
  3. Navigate to the frontend directory (cd frontend).
  4. Type 'npm test' and press 'Enter'.
  5. Wait for the tests to give a response in the terminal.

Security 🛡️


Applied Helmet security to the Express app.

  • Protects the app from well-known web vulnerabilities by setting HTTP headers appropriately.
  • Prevents cross-site scripting attacks.
  • Enforces secure (HTTPS) connections to the server.
  • Protects from clickjacking

Reference: https://expressjs.com/en/advanced/best-practice-security.html

This application has not made use of API keys. I could not find information about the use of API keys on the iTunes Store API documentation page.



About

An application that allows a user to search for media found on the iTunes Store

Resources

Stars

Watchers

Forks