Skip to content

Latest commit

 

History

History
130 lines (105 loc) · 4.43 KB

README.md

File metadata and controls

130 lines (105 loc) · 4.43 KB

Build Status Netlify Status

Movie Search

🚀 View Live Demo 🚀

Movie Search Preview

Description

React Movie Search, created with React (Hooks/Effect), HTML, FlexBox, SASS, FontAwesome. Connecting to The Movie DB via a RESTful API, converted to JSON Format.

Features

Project features:

  • Custom Reuseable `Fetch API` Hook
  • Dynamic Sticky Header (Un-stuck when viewing in mobile landscape orientation to maximise view <415px height)
  • `Back-to-top` Scroll Feature
  • Custom User-Friendly Error Messages
  • Search Preloader Animation
  • Fully Responsive/Mobile Optimised Layout using CSS FlexBox
  • Flip Card Animation using CSS
  • `Null Image` Image Place Holder
  • `Top Movie Search` Deep Links
  • Pop-out Burger Menu with Transitions
  • Custom Fav Ico
  • FontAwesome Icons
  • PWA Enabled
  • Continuous Deployment (CD) from GitHub Repo to Netlify Host Server

NPM Modules

The following dependencies are used to run this project;

"dependencies": {
  "@fortawesome/fontawesome-svg-core": "^1.2.35",
  "@fortawesome/free-brands-svg-icons": "^5.15.3",
  "@fortawesome/free-solid-svg-icons": "^5.15.3",
  "@fortawesome/react-fontawesome": "^0.1.14",
  "@testing-library/jest-dom": "^5.14.1",
  "@testing-library/react": "^11.2.7",
  "@testing-library/user-event": "^12.8.3",
  "react": "^17.0.2",
  "react-dom": "^17.0.2",
  "react-scripts": "4.0.3",
  "web-vitals": "^0.2.4",
  "workbox-background-sync": "^5.1.4",
  "workbox-broadcast-update": "^5.1.4",
  "workbox-cacheable-response": "^5.1.4",
  "workbox-core": "^5.1.4",
  "workbox-expiration": "^5.1.4",
  "workbox-google-analytics": "^5.1.4",
  "workbox-navigation-preload": "^5.1.4",
  "workbox-precaching": "^5.1.4",
  "workbox-range-requests": "^5.1.4",
  "workbox-routing": "^5.1.4",
  "workbox-strategies": "^5.1.4",
  "workbox-streams": "^5.1.4"
},
"devDependencies": {
  "sass": "^1.36.0"
}

Installation Instructions

Open your Code Editor and 'CD' into your working directory, then download the repo to that location.

git clone https://github.com/rbhachu/movie-search

Once the repo has been downloaded, 'CD' to the newly downloaded project folder; 'cd movie-search'.

npm install

The Movie Database API

In order to run the site you will need to register to aquire a free API Key from The Movie Database, which is the service provider for the Movie information data we will be connecting to aquire.
TMDB FREE API Link

.env file (file path: ./.env/)

Once you have aquired the API Key from TMDB, you will need to update the .env file (situated in the root of the site folder) with the API key value.

Replace xxxxx with your API Key

REACT_APP_API_KEY="xxxxx"


Usage Instructions

Finally, to run the project, simply execute the following command in your terminal (ensuring you are in the correct project directory too).

npm start

After a few seconds, your browser should automatically open to the following link and display the project in your default browser;

http://localhost:3000

Movie Search Preview

Author

👤 Rishi Singh Bhachu

Issues

Please drop me a message if you have any issues or problems running the project.

Show your support

Give a ⭐️ if this project helped you!