Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aviralmehrotra/retro-flix
Retro Flix is a simple React application that allows you to search for movies and add them to your watched list. You can also rate the movies you've watched and see statistics about your watched movies.
https://github.com/aviralmehrotra/retro-flix
movie-database omdb-api reactjs
Last synced: 3 days ago
JSON representation
Retro Flix is a simple React application that allows you to search for movies and add them to your watched list. You can also rate the movies you've watched and see statistics about your watched movies.
- Host: GitHub
- URL: https://github.com/aviralmehrotra/retro-flix
- Owner: AviralMehrotra
- License: mit
- Created: 2023-09-10T04:12:38.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-09-21T03:05:11.000Z (about 1 year ago)
- Last Synced: 2023-09-21T14:13:45.087Z (about 1 year ago)
- Topics: movie-database, omdb-api, reactjs
- Language: JavaScript
- Homepage: https://retro-flix.vercel.app/
- Size: 396 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Retro Flix React App 🎬
Retro Flix is a simple React application that allows you to search for movies and add them to your watched list. You can also rate the movies you've watched and see statistics about your watched movies.
## Demo 📺
You can experience Retro Flix by visiting the [demo](https://retro-flix.vercel.app/).
## Table of Contents 📋
- [Getting Started](#getting-started)
- [Features](#features)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Getting Started 🚀
To get started with Retro Flix, follow these steps:
1. Clone the repository to your local machine:
```shell
git clone https://github.com/yourusername/retro-flix.git
```
2. Change into the project directory:
```shell
cd retro-flix
```
3. Install the required dependencies:
```shell
npm install
```
4. Get an API key from [OMDb API](http://www.omdbapi.com/apikey.aspx) and replace `"YOUR_API_KEY"` in `App.js` with your actual API key.
5. Start the development server:
```shell
npm start
```
6. Open your web browser and visit [http://localhost:3000](http://localhost:3000) to use Retro Flix.
## Features 🌟
- Search for movies by title 🔍.
- View movie details, including title, year, poster, runtime, IMDb rating, plot, and more.
- Add movies to your watched list and rate them ⭐.
- View statistics about your watched movies, including average IMDb rating, average user rating, and average runtime.
- Remove movies from your watched list.
## Usage 🎯
Once you have the Retro Flix application up and running, you can perform the following actions:
### Search for Movies 🔍
1. Use the search input at the top to enter the title of the movie you want to search for.
2. As you type, the search results will be displayed below.
### View Movie Details 🎥
1. Click on a movie from the search results to view its details.
2. You can see information such as the movie's title, year, poster, runtime, IMDb rating, and plot.
3. Rate the movie using the star rating system if it's a movie you've watched.
### Add Movies to Watched List ⭐
1. When viewing the details of a movie, you can click the "+ Add to List" button to add it to your watched list.
2. Rate the movie using the star rating system.
### View Watched Movies 👁️
1. Click on the "Watched" tab to view your watched movies.
2. You can see a summary of your watched movies, including the number of movies, average IMDb rating, average user rating, and average runtime.
3. Click on a watched movie to see its details, or remove it from your watched list.
## Contributing 🤝
Contributions to Retro Flix are welcome! If you find a bug or have an idea for an enhancement, please open an issue or create a pull request on the [GitHub repository](https://github.com/aviralmehrotra/retro-flix).
## License 📄
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. 📜