Skip to content

Commit b22b250

Browse files
SamSam
authored andcommitted
🎬 Add cyberpunk-themed README with animations and live demo link
1 parent 538ad75 commit b22b250

1 file changed

Lines changed: 223 additions & 10 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 223 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,230 @@
1-
# React + Vite
1+
# 🎬 CINEHUB
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
<div align="center">
44

5-
Currently, two official plugins are available:
5+
![CineHub Logo](https://readme-typing-svg.herokuapp.com?font=VT323&size=60&duration=3000&pause=500&color=ff4500&center=true&vCenter=true&multiline=true&width=800&height=100&lines=CINEHUB;RETRO+FLUENT+MOVIE+DISCOVERY)
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7+
[![Live Demo](https://img.shields.io/badge/πŸš€-LIVE_DEMO-ff4500?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTEgMTNMMTQgOEwxIDEzVjFaTTEgMXYxMkgxNFYxSDFaIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIxIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz4KPC9zdmc+&logoColor=white)](https://sam97300.github.io/Cine-Hub/)
8+
[![GitHub stars](https://img.shields.io/github/stars/Sam97300/Cine-Hub?style=for-the-badge&logo=github&color=ffb700)](https://github.com/Sam97300/Cine-Hub)
9+
[![React](https://img.shields.io/badge/REACT-19.2.0-61dafb?style=for-the-badge&logo=react&logoColor=black)](https://react.dev/)
10+
[![Vite](https://img.shields.io/badge/VITE-7.2.4-646cff?style=for-the-badge&logo=vite&logoColor=white)](https://vite.dev/)
911

10-
## React Compiler
12+
---
1113

12-
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
14+
*A cyberpunk movie discovery experience with retro-fluent aesthetics*
1315

14-
## Expanding the ESLint configuration
16+
</div>
1517

16-
If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
17-
# Cine-Hub
18+
## 🌟 Overview
19+
20+
CineHub is a cutting-edge movie discovery platform that brings together the nostalgia of retro computing with modern web technologies. Dive into a universe of cinema through a beautifully crafted interface featuring:
21+
22+
- 🎭 **Trending Movies Stream** - Real-time trending data from TMDB
23+
- πŸ” **Smart Search Autocomplete** - Instant movie discovery
24+
- πŸ“Š **Detailed Analytics** - Movie statistics and insights
25+
- πŸ‘€ **Personal Profiles** - Track your watchlist and preferences
26+
- 🎨 **Cyberpunk UI** - Retro-fluent design with CRT effects
27+
28+
## πŸš€ Live Experience
29+
30+
> **πŸ”— [**LIVE DEMO**](https://sam97300.github.io/Cine-Hub/)**
31+
>
32+
> Experience the full cyberpunk movie discovery journey
33+
34+
---
35+
36+
## ✨ Features
37+
38+
### 🎬 **Movie Discovery**
39+
- **Trending Data Stream** - Real-time movie trends with animated loading states
40+
- **Advanced Search** - Intelligent autocomplete with instant results
41+
- **Detailed Views** - Comprehensive movie information including cast, crew, and statistics
42+
43+
### 🎨 **Retro-Fluent Design**
44+
- **CRT Effects** - Authentic scanlines and grain effects
45+
- **Glass Morphism** - Modern glass panels with backdrop blur
46+
- **Cyberpunk Color Scheme** - Orange accent (#ff4500) with cyan highlights
47+
- **Smooth Animations** - Hover effects, transitions, and micro-interactions
48+
49+
### πŸ“± **Modern Architecture**
50+
- **Progressive Web App** - PWA capabilities with offline support
51+
- **Responsive Design** - Optimized for all devices
52+
- **Performance Optimized** - Built with Vite for lightning-fast loading
53+
54+
---
55+
56+
## πŸ› οΈ Tech Stack
57+
58+
```mermaid
59+
%%{init: {
60+
'theme': 'dark',
61+
'themeVariables': {
62+
'primaryColor': '#ff4500',
63+
'primaryTextColor': '#eaeaea',
64+
'primaryBorderColor': '#ffb700',
65+
'lineColor': '#ffb700',
66+
'sectionBkgColor': '#0b0b0b',
67+
'altSectionBkgColor': '#121212'
68+
}
69+
}}%%
70+
graph LR
71+
A[React 19.2.0] --> B[Vite 7.2.4]
72+
B --> C[TailwindCSS]
73+
C --> D[TMDB API]
74+
D --> E[Lucide Icons]
75+
E --> F[Chart.js]
76+
```
77+
78+
### Core Technologies
79+
- **Frontend**: React 19.2.0 with modern hooks
80+
- **Build Tool**: Vite 7.2.4 for optimal development experience
81+
- **Styling**: TailwindCSS with custom cyberpunk theme
82+
- **API**: TMDB (The Movie Database) for movie data
83+
- **Icons**: Lucide React for consistent iconography
84+
- **Charts**: Chart.js for movie statistics visualization
85+
86+
---
87+
88+
## 🎯 Quick Start
89+
90+
### Prerequisites
91+
- Node.js 18+
92+
- npm or yarn
93+
94+
### Installation
95+
96+
```bash
97+
# Clone the repository
98+
git clone https://github.com/Sam97300/Cine-Hub.git
99+
cd Cine-Hub
100+
101+
# Install dependencies
102+
npm install
103+
104+
# Start development server
105+
npm run dev
106+
```
107+
108+
### Available Scripts
109+
110+
```bash
111+
npm run dev # Start development server
112+
npm run build # Build for production
113+
npm run preview # Preview production build
114+
npm run deploy # Deploy to GitHub Pages
115+
```
116+
117+
---
118+
119+
## 🎨 Design System
120+
121+
### Color Palette
122+
```css
123+
:root {
124+
--bg: #0b0b0b; /* Deep black background */
125+
--panel: rgba(18, 18, 18, 0.6); /* Glass panels */
126+
--accent: #ff4500; /* Cyberpunk orange */
127+
--cyan: #ffb700; /* Retro cyan */
128+
--text: #eaeaea; /* Light text */
129+
--muted: #9a9a9a; /* Muted text */
130+
}
131+
```
132+
133+
### Typography
134+
- **Display**: VT323 (retro terminal font)
135+
- **Body**: Inter (modern, clean sans-serif)
136+
137+
### Effects
138+
- **Scanlines**: Authentic CRT monitor effect
139+
- **Grain**: Subtle noise texture
140+
- **Glass Morphism**: Backdrop blur with transparency
141+
- **Hover Animations**: Smooth transitions and transforms
142+
143+
---
144+
145+
## πŸ“Έ Screenshots
146+
147+
<div align="center">
148+
149+
![CineHub Interface](https://readme-typing-svg.herokuapp.com?font=VT323&size=20&duration=2000&pause=1000&color=ffb700&center=true&vCenter=true&lines=🎬+CYBERPUNK+MOVIE+DISCOVERY;πŸš€+RETRO+FLUENT+INTERFACE;✨+MODERN+WEB+TECHNOLOGIES)
150+
151+
</div>
152+
153+
---
154+
155+
## πŸ”§ Configuration
156+
157+
### Environment Variables
158+
Create a `.env` file in the root directory:
159+
160+
```env
161+
VITE_TMDB_API_KEY=your_tmdb_api_key_here
162+
```
163+
164+
### TMDB API Setup
165+
1. Visit [TMDB](https://www.themoviedb.org/)
166+
2. Create an account and request an API key
167+
3. Add the API key to your environment variables
168+
169+
---
170+
171+
## πŸš€ Deployment
172+
173+
### GitHub Pages
174+
The project is configured for automatic deployment to GitHub Pages:
175+
176+
```bash
177+
# Deploy to GitHub Pages
178+
npm run deploy
179+
```
180+
181+
### Manual Deployment
182+
```bash
183+
# Build the project
184+
npm run build
185+
186+
# Deploy the dist folder to your hosting provider
187+
```
188+
189+
---
190+
191+
## 🀝 Contributing
192+
193+
We welcome contributions! Here's how to get started:
194+
195+
1. **Fork** the repository
196+
2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
197+
3. **Commit** your changes (`git commit -m 'Add amazing feature'`)
198+
4. **Push** to the branch (`git push origin feature/amazing-feature`)
199+
5. **Open** a Pull Request
200+
201+
### Development Guidelines
202+
- Follow the existing code style and patterns
203+
- Ensure all animations are smooth and performant
204+
- Test responsive behavior on multiple devices
205+
- Maintain the cyberpunk aesthetic consistency
206+
207+
---
208+
209+
## πŸ“„ License
210+
211+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
212+
213+
---
214+
215+
## πŸ™ Acknowledgments
216+
217+
- **TMDB** for providing the movie database API
218+
- **React Team** for the amazing framework
219+
- **Vite Team** for the lightning-fast build tool
220+
- **TailwindCSS** for the utility-first CSS framework
221+
222+
---
223+
224+
<div align="center">
225+
226+
![CineHub](https://readme-typing-svg.herokuapp.com?font=VT323&size=24&duration=4000&pause=1000&color=ff4500&center=true&vCenter=true&lines=🎬+CINEHUB+🎬;RETRO+FLUENT+MOVIE+DISCOVERY;THANKS+FOR+VISITING!)
227+
228+
[![Back to top](https://img.shields.io/badge/BACK_TO_TOP-ff4500?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTggMTJMMTMgN0w4IDJMMyA3TDggMTJaIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIxIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz4KPC9zdmc+&logoColor=white)](#-cinehub)
229+
230+
</div>

0 commit comments

Comments
Β (0)