diff --git a/README.md b/README.md index 04a6d9c4..3c9fbadc 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,33 @@ ---- -path: "/project-cinema" -date: "2018-05-28" -title: "Project cinema" ---- +# ~~Mission Impossible~~ Project Cinema -# Project Cinema +This assignment's brief is to create a movie search website that allows the user to enter a movie title and return information about the movie. -We want to create a movie search engine. To power it we will use the [Open Movie Database](http://www.omdbapi.com). It provides access to a huge database of films via an **API**, which stands for **Application Programming Interface**. In short, it is a set of rules and procedures you need to follow to use a remote system. +## My Personal Brief -> Check out this video for some background info on APIs -> [https://www.youtube.com/watch?v=s7wmiS2mSXY](https://www.youtube.com/watch?v=s7wmiS2mSXY) +My emphasis was on getting to grips and learning as much as I could about the fetch, handling and processing of the data that was returned. I experimented with a number of methods of displaying the data. I tried a table but realised that was cumbersome, and a flex box of 2 separate divs was all that was needed. I put the data in a map object with the IMDB film ID as the key. I thought it would be useful to be able to refer back to the movie map if more functionality was to be added at a later stage. The site is by no means finished. I ran out of time to implement a previous results but I am pleased I managed to retrieve more than one page of data. -To start using the OMDB API you will first need to sign up with them to receive and API key. The key issued to you will allow you 1000 requests per day and you will need to include this key as part of every request. +## Running the Website -To get started, fork and clone the repo at [https://github.com/dmitrigrabov/project-cinema](https://github.com/dmitrigrabov/project-cinema). Please submit a pull request after your first commit and push commits regularly. +Ensure that all the files : cine_index.html, cine_index.css, cine_index.js and cinema2.jpg are all within the same folder and open the cine_index.html file in a browser. -You should complete as many of the following tasks as you can. +## Current Features Implemented -- [ ] Create an HTML page which should have a `form` at the top which contains a text input and a submit button. Below it should have a placeholder for the returned results. -- [ ] Use JavaScript to capture the submit `event` in your search form, extract the query string from your input and use that to make an API call to the Open Movie Database API to search for films which match the query string using `fetch`. `console.log` the results -- [ ] Display the data returned by the API including title, year and poster picture -* Adjust your layout to create room for a detailed view of movie information -- [ ] Capture clicks on your movie results items and use that information to make another request to the API for detailed movie information. `console.log` the returned result -- [ ] Display the detailed movie result in the in the details view you created earlier +1. Basic Movie search on title - pressing enter or clicking the button will return the first 10 movie results that include the movie title entered +2. Clicking on a movie poster will re-direct the user to the IMDB page in a new tab for that movie +3. Clicking on the movie title will return the following information for the movie : Age Rating, Plot Summary, Director, Actors and Review ratings from IMDB, Rotten Tomatoes and Metacritic +4. Clicking on the Next page link will retrieve the next 10 results with the same functionality as previous -**Your own feature** +## Bugs -- [ ] Implement any feature you would find useful or interesting +I tested my code as I went along and fixed the major problems, however, a few smaller bugs still exist: +1. Clicking Next Page twice results in the previous navigation heading not clearing so the header gets messy but the data is still returned +2. Have not implemented a minimum width so is only responsive up to a point then movie detailed text will overlap over the movie poster +3. Could not get a placeholder picture to work instead of missing movie poster, but included Alt Text that will also link to imdb page. +4. Entering a new film title and clicking search after a previous search adds new results to the bottom of the page. -**Stretch goals** -- [ ] Implement pagination so that users can navigate between all movies in search results rather than just the first ten -- [ ] Make your design responsive and ensure it looks great at different screen widths -- [ ] Create a favourites list. It's up to you how you would add items to favourites. You could add a button or otherwise. Display a list of favourites somewhere on your page. -- [ ] Make the favourites list sortable. Add `up` and `down` buttons to your favourites which on click will move the result in relevant direction -- [ ] Save favourites locally using `localStorage` so that favourites persist in browser after refresh -- [ ] Let's create a search preview. It should listen for change events on input events and submit a search request with current query string. Display the search preview results in an absolute positioned container just below the search box. -Hint: You may want to kick of the searching after at least 3 characters have been typed. +## Conclusion -## Objectives +The biggest lesson that I learnt was to take some time out at the start of the project to sketch out a design, not only for the webpage but also to think about the structure of the code, possible functions and to write algorithms or pseudo code. I would like to finish the website in my spare time... so beware bugs! _"I'll be back..."_ -* We want to see great looking webpages -* Your code should have consistent indentation and sensible naming -* Use lots of concise functions with a clear purpose -* Add code comments where it is not immediately obvious what your code does -* Your code should not throw errors and handle edge cases gracefully. For example not break if server fails to return expected results - -## README.md - -When finished, include a README.md in your repo. This should explain what the project is, how to run it and how to use it. Someone who is not familiar with the project should be able to look at it and understand what it is and what to do with it. +## Credits +Photo courtesy of Jakob Owens on Unsplash diff --git a/cine_index.css b/cine_index.css new file mode 100644 index 00000000..17d4634d --- /dev/null +++ b/cine_index.css @@ -0,0 +1,56 @@ +* { + box-sizing: border-box; +} +html { + margin: 0; + font-family: Haettenschweiler, "Arial Narrow Bold", sans-serif; + background-color: lightgray; +} +h1 { + margin:20px; + /* font-family: 'Gloria Hallelujah', cursive; */ + font-family: 'Permanent Marker', cursive; + font-size: 50px; + /* font-family: 'Monoton', cursive; */ +} +#search__form{ + margin:20px; +} +#results__next{ + color:white; +} + +.search { + margin: 0; + padding-top: 20px; + height: 35vh; + text-align: left; + color: white; + background-image: url(cinema2.jpg); + background-repeat: no-repeat; + background-size: cover; + background-position: center left; + font-family: "Snippet", sans-serif; +} +li { + list-style-type: none; + display: flex; + margin: 30px; + justify-content: flex-start; + min-width: 200px; +} +#results__info { + background: yellow; +} + +/* a { + color: inherit;; + text-decoration: none; +} */ +/* .container { + text-align: left; +} */ + +input { + width: 10%; +} diff --git a/cine_index.html b/cine_index.html new file mode 100644 index 00000000..69fa824a --- /dev/null +++ b/cine_index.html @@ -0,0 +1,33 @@ + + + + + + + + + Project Cinema + + + + +
+

Project Cinema

+
+ + + +
+ +
+ +
+
+ +
+
+ + + + \ No newline at end of file diff --git a/cine_index.js b/cine_index.js new file mode 100644 index 00000000..4864824b --- /dev/null +++ b/cine_index.js @@ -0,0 +1,143 @@ +const searchStr = query("search__text"); +const searchButton = query("search__button"); +const searchForm = query("search__form"); +const searchRes = query("search__form"); +let resContainer = query("results__container"), + parentNode = query("results__list"); +let movieMap = new Map(), + movieArr = [], + htmlStr = "", + nextStr = "", + movieID = "", + pageNum = 1; + +//DRY Short Functions +function query(eleID) { + return document.querySelector(`#${eleID}`); +} + +function createNode(element) { + return document.createElement(element); +} + +function append(parent, element) { + return parent.appendChild(element); +} + +function remove(parent, element) { + return parent.removeChild(element); +} + +//Listener for title Search +searchForm.addEventListener("submit", fetchMovies); + +//Fetch Data Function for 10 movies +function fetchMovies() { + event.preventDefault(); + let searchURL = `http://www.omdbapi.com/?s=${ + searchStr.value + }&page=${pageNum}&apikey=39d7228f`; + + //Fetch actual start + fetch(searchURL) + .then(function(response) { + return response.json(); + }) + //Process useful fetch data + .then(function(myJsonData) { + // console.log(myJsonData); + let newNode = createNode("div"); + let htmlStr = `
+

Showing ${10 * pageNum} of ${ + myJsonData.totalResults + } films found

`; + + //if there are more than 10 films display a 'Next' link + if (myJsonData.totalResults > 10) { + htmlStr += ` Next page `; + // htmlStr += ` Next 10 results `; + pageNum++; + } + newNode.innerHTML = htmlStr; + append(searchRes, newNode); + + //Iterate through data and populate Movie Map + //Map Structure = [imdbID : [poster, title, year] + myJsonData.Search.forEach(function(film) { + movieMap[film.imdbID] = [film.Poster, film.Title, film.Year]; + displayMovieList(film.imdbID, movieMap); + }); + }); +} + +//Display Basic film info(Poster, Title & Year) from Movie map with imdbID key +function displayMovieList(movieID, movieListMap) { + if (pageNum > 1) { + console.log(movieListMap); + console.log(movieListMap.size); + } + let htmlStr = `
+ + Movie poster + ${ + movieListMap[movieID][1] + } (${movieListMap[movieID][2]}) +
`; + + // Create list of results and display + let newNode = createNode("li"); + newNode.innerHTML = htmlStr; + parentNode = query("results__list"); + append(parentNode, newNode); +} +// Fetch detailed movie information for one movie +// This function is called from the "on-click" action in html on the film title +function moreInfo(filmID) { + if (typeof(results__info) !== 'undefined'){ + parentNode = query(results__info); + while (parentNode.firstChild) { + parentNode.firstChild.remove(); + } + } + fetch(`http://www.omdbapi.com/?i=${filmID}&plot=full&apikey=39d7228f`) + .then(function(response) { + return response.json(); + }) + .then(function(myJsonData) { + console.log(myJsonData); + myJsonData.Ratings.forEach( + rating => (htmlStr += ` ${rating["Source"]} ${rating["Value"]} `) + ); + // Displays data straight from myJsonData (not stored separately) + let infoStr = ` + Age Rating: ${myJsonData.Rated}
+ Summary: ${myJsonData.Plot}
+ Director: ${myJsonData.Director}
+ Actors: ${myJsonData.Actors}
+ Ratings:${htmlStr} + `; + // console.log("more info string ", moreInfo); + parentNode = document.querySelector(`#${filmID}`); + // Create paragraph of results and display + let infoNode = createNode("div"); + infoNode.innerHTML = infoStr; + parentNode.after(infoNode); + }); +} + +//clear page in preparation for new display of films +function nextMovies() { + //need to clear children of results__list; + parentNode = query("results__list"); + while (parentNode.firstChild) { + parentNode.firstChild.remove(); + } + //need to clear children of results__nav; + parentNode = query("results__nav"); + while (parentNode.firstChild) { + parentNode.firstChild.remove(); + } + fetchMovies(); +} +// .catch(function(error) { +//console.log(error)}); diff --git a/cinema2.jpg b/cinema2.jpg new file mode 100644 index 00000000..e6c89f23 Binary files /dev/null and b/cinema2.jpg differ