Giter VIP home page Giter VIP logo

media-search's Introduction

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.



media-search's People

Contributors

chadprobert avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.