IMDbuddy

IMDbuddy is a web application that allows users to search for movies, view details about them, and save their favorite movies for later.

Table of Contents

• Features
• Technologies Used
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Testing
• Contributing
• License

Features

• Search for movies by title or release year
• View detailed information about each movie, including title, release year, genre, plot, and more
• Save favorite movies locally on your device (via localstorage)

Technologies Used

• React.js
• TypeScript
• Material-UI
• Axios
• Jest (for testing)

Getting Started

Prerequisites

Before running the application locally, ensure you have the following prerequisites installed:

• Node.js and npm (Node Package Manager) - Download & Install Node.js
• Git - Download & Install Git

Installation

1. Clone the repository:

   git clone https://github.com/your-username/imdbuddy.git

2. Navigate to the project directory:

   cd imdbuddy

3. Install dependencies:

   npm install

Usage

1. Start the development server:

   npm start

2. Open your web browser and navigate to http://localhost:3000 to view the application.

Testing

IMDbuddy includes unit and integration tests to ensure the reliability of the codebase. To run the tests, use the following command:

npm test

Contributing

Contributions are welcome! If you'd like to contribute to IMDbuddy, please follow these steps:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/your-feature-name)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin feature/your-feature-name)
5. Create a new Pull Request

Please adhere to the Contributing Guidelines and Code of Conduct when contributing to this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.