Skip to content

Latest commit

 

History

History
93 lines (66 loc) · 3.95 KB

README.md

File metadata and controls

93 lines (66 loc) · 3.95 KB
Raw

Full-stack engineer @Invact

Project Specification Document: Movie Watchlist Application

Project Overview

The Movie Watchlist application is a web-based tool that allows users to manage a list of movies they want to watch. Users can add, edit, and delete movies from their watchlist, mark movies as watched or unwatched, and rate and review movies. State management will be handled using Redux to ensure efficient and predictable state updates.

Key Features

  1. Add Movies
    • Users can add movies to their watchlist by providing details such as the movie title, description, release year, and genre.
    • Each movie should have a unique identifier.
  2. Edit Movies
    • Users can edit the details of movies already in their watchlist.
  3. Delete Movies
    • Users can delete movies from their watchlist.
  4. Mark Movies as Watched/Unwatched
    • Users can toggle the status of a movie between watched and unwatched.
  5. Rate and Review Movies
    • Users can rate movies on a scale of 1 to 5 stars.
    • Users can provide a text review for each movie.
  6. State Management with Redux
    • All state changes (adding, editing, deleting movies, marking as watched/unwatched, rating, and reviewing) will be managed using Redux.

Functional Requirements

1. Movie Management

  • Add Movie
    • Form fields: Title (required), Description, Release Year, Genre.
    • On successful submission, the movie is added to the watchlist.
  • Edit Movie
    • Users can select a movie from the watchlist to edit its details.
    • Form fields pre-filled with existing movie details.
    • On successful submission, the movie details are updated.
  • Delete Movie
    • Users can delete a movie from the watchlist.
    • Confirmation prompt before deletion.

2. Watch Status Management

  • Mark as Watched/Unwatched
    • Toggle button or checkbox to mark a movie as watched or unwatched.

3. Rating and Reviewing

  • Rate Movie
    • Star rating component allowing users to rate a movie from 1 to 5 stars.
  • Review Movie
    • Textarea input for users to write a review.

Technical Specifications

1. Technology Stack

  • Frontend:
    • React.js for building the user interface.
    • Redux for state management.
    • CSS/SCSS for styling.
  • Backend:
    • Mock API using JSON server or a similar tool for the initial implementation.
    • Optionally, a Node.js/Express server if a custom backend is needed later.
  • Database:
    • JSON file for storing movie data in the initial phase.
    • Optionally, a NoSQL database like MongoDB for persistent storage.

User Interface Design

1. Home Page

  • Display a list of movies in the watchlist.
  • Buttons/links to add a new movie, edit or delete existing movies, and mark movies as watched/unwatched.

2. Add/Edit Movie Page

  • Form for adding or editing movie details.
  • Fields: Title, Description, Release Year, Genre.
  • Save and Cancel buttons.

3. Movie Details Page

  • Display movie details including title, description, release year, genre, watch status, rating, and reviews.
  • Options to edit or delete the movie, mark it as watched/unwatched, and add/edit a rating and review. This project heavily uses "React Routing" as we needed to route between "Watchlist","Watched" and "Add" page without any reload so routing plays an important role here.

we needed to maintain states thats why "useState" was used. Along with "useEffect" for causing side effect and "fetch api" for fetching the movie according to our search from the "TMDb Api".

There was a major problem about the movie switching control i.e when we would want to remove a movie/move a movie from Watchlist to watched/vice-versa then there was a rising problem about "prop-drilling" which was solved using "Context Api" for removing/switching a GLobalCOntext was maintained.

And another thing was to store the the movies which we saved for Watchlist/Watched even if we close the app and for that i took the help of "localstorage".