Skip to content

vikasbhalla05/Movies-Explorer

Repository files navigation

Here's an updated README.md tailored for your repository Movies Explorer:


🎥 Movies Explorer

Movies Explorer is a React-based web application that allows users to search for movies and view their details. It utilizes the OMDb API to fetch movie data and provides a user-friendly interface with dynamic search functionality.


🛠 Features

  • Search Movies: Search for movies by their title using the search bar.
  • View Movie Details: Click on a movie card to navigate to a detailed page.
  • Dynamic UI: Modern and responsive design with Tailwind CSS.
  • State Management: Centralized state handled via React Context API.

🚀 Getting Started

Follow the steps below to run the project locally.

1. Clone the Repository

git clone https://github.com/vikasbhalla05/Movies-Explorer.git
cd Movies-Explorer

2. Install Dependencies

Ensure you have Node.js installed on your machine. Then, run:

npm install

3. Set Up Environment Variables

Create a .env file in the root directory with the following content:

REACT_APP_OMDB_API_KEY=your_api_key

Replace your_api_key with your OMDb API key, which you can obtain here.

4. Run the Development Server

npm start

Visit the app at http://localhost:3000.


📂 Project Structure

src/
├── components/
│   ├── MovieCard.js        # Displays individual movie data
│   ├── SearchBar.js        # Handles search functionality
├── context/
│   └── AppContext.js       # Manages global state with Context API
├── pages/
│   ├── Home.js             # Main page for search and results
│   ├── MovieDetails.js     # Displays detailed movie information
├── App.js                  # Main application component
└── index.js                # Entry point of the application

🖼 Screenshots

Home Page

Home Page

Search Results

Search Results


🧑‍💻 Technologies Used

  • Frontend Framework: React
  • Routing: React Router
  • Styling: Tailwind CSS
  • State Management: React Context API
  • API: OMDb API

🏗 Planned Improvements

  • Implement pagination for better search result handling.
  • Add loading skeletons for smoother UX during API calls.
  • Optimize image loading with lazy loading.
  • Introduce unit and integration tests.

🤝 Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature.
  3. Commit your changes: git commit -m "Add new feature".
  4. Push to the branch: git push origin feature/your-feature.
  5. Submit a pull request.

📜 License

This project is licensed under the MIT License. See the LICENSE file for more details.


🌟 Acknowledgments

  • OMDb API for powering the movie data.
  • React Community for providing excellent libraries and tools.

Feel free to update the screenshots and add any additional sections based on your project’s needs!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published