An open API service indexing awesome lists of open source software.

https://github.com/y2-znt/CineQuik

CineQuik is an app for movie enthusiasts to explore detailed film information, watch trailers, and more. ๐Ÿฟ
https://github.com/y2-znt/CineQuik

motion react react-query react-router-dom tanstack-query tanstack-react-query

Last synced: 10 months ago
JSON representation

CineQuik is an app for movie enthusiasts to explore detailed film information, watch trailers, and more. ๐Ÿฟ

Awesome Lists containing this project

README

          

# ๐ŸŽฌ CineQuik โ€“ Your Ultimate Movie Explorer

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
![TanStack Query](https://img.shields.io/badge/-TanStack%20Query-FF4154?style=for-the-badge&logo=react%20query&logoColor=white)
![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)

[![Website](https://img.shields.io/website?url=https%3A%2F%2Fcinequik.vercel.app&style=flat-square)](https://cinequik.vercel.app/)

**A modern and immersive movie discovery platform powered by TMDB API**

[Live Demo](https://cinequik.vercel.app) โ€ข
[Features](#-features) โ€ข
[Getting Started](#-getting-started) โ€ข
[Tech Stack](#-tech-stack) โ€ข
[Implementation](#-key-features-implementation) โ€ข
[Contributing](#-contributing) โ€ข
[Support](#-support)

image

## ๐ŸŒŸ Features

- **๐Ÿ” Intuitive Search**: Instantly find any movie from the TMDB database
- **๐Ÿ”ฅ Curated Lists**: Explore โ€œPopularโ€ and โ€œTop-Ratedโ€ movie selections
- **๐Ÿ“„ Detailed Info**: See runtime, ratings, release dates, trailers, similar movies & more
- **๐Ÿ“ฝ Watch Options**: Direct links to official providers when available
- **โšก Fast Performance**: Vite-powered builds with lazy loading and code splitting
- **๐Ÿ’… Modern UI**: Sleek, responsive layout with smooth transitions

---

## ๐Ÿ› ๏ธ Tech Stack

### Core

- **Frontend Framework**: React 18
- **Build Tool**: Vite
- **Routing**: React Router v6
- **State & Caching**: TanStack Query (React Query)

### Libraries & Tools

- **HTTP Client**: Axios
- **UI/UX Enhancements**:
- Swiper.js (Carousels)
- React-Youtube
- Motion (Framer Motion-compatible)
- **API**: [TMDB โ€“ The Movie Database](https://www.themoviedb.org/)

---

## ๐Ÿš€ Getting Started

### ๐Ÿ“ฆ Prerequisites

- Node.js (v14+)
- npm or yarn
- TMDB API key (free)

### ๐Ÿ”ง Installation

1. Clone the repo

```bash
git clone https://github.com/Yoni-Deserbaix/CineQuik.git
```

2. Move into the project folder

```bash
cd CineQuik
```

3. Install dependencies

```bash
npm install
# or
yarn install
```

4. Create a `.env` file at the root of the project and add your TMDB API key:

```bash
VITE_API_KEY=your_api_key_here
```

5. Run in dev mode

```bash
npm run dev
# or
yarn dev
```

Visit http://localhost:5173 - You're ready to explore! ๐ŸŽ‰

---

## ๐Ÿ’ก Key Features Implementation

### ๐Ÿ”„ Data Fetching & Caching

- Cached queries with stale-time strategies
- Real-time search with debounced inputs
- Error handling & loading skeletons per section

### ๐ŸŽฏ UX & UI

- Mobile-first responsive design
- Custom skeletons, animations and page transitions
- Lazy loaded components for fast initial load

---

## ๐Ÿค Contributing

We welcome contributions! ๐Ÿง โœจ
You can improve features, fix bugs or suggest ideas.

[![contributors](https://contrib.rocks/image?repo=Yoni-Deserbaix/CineQuik)](https://github.com/Yoni-Deserbaix/CineQuik/graphs/contributors)

### Contribution Guide

1. Fork the repo
2. Create a new branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add AmazingFeature'`)
4. Push to your fork (`git push origin feature/AmazingFeature`)
5. Submit a pull request ๐Ÿงƒ

---

## ๐Ÿ“ Support

- ๐Ÿ“ฎ Found a bug? [Open an issue](https://github.com/Yoni-Deserbaix/CineQuik/issues/new)
- ๐Ÿ’ก Have a feature idea? [Request it here](https://github.com/Yoni-Deserbaix/CineQuik/issues/new)

---

## ๐ŸŽจ Credits

- ๐ŸŽฌ [TMDB API](https://www.themoviedb.org/) โ€“ the backbone of the movie data
- ๐Ÿ’ก Inspired by multiple open-source movie discovery apps

---

Made with โค๏ธ by [y2-znt](https://github.com/y2-znt)