aethex.live/README.md
copilot-swe-agent[bot] 944b4f3ef5 docs: update README with project information and usage guide
Co-authored-by: MrPiglr <31398225+MrPiglr@users.noreply.github.com>
2026-02-07 02:33:53 +00:00

100 lines
2.7 KiB
Markdown

# AeThex Live
A modern live streaming platform built with Next.js, featuring HLS video playback, real-time chat, and a sleek sci-fi aesthetic.
![AeThex Live](https://github.com/user-attachments/assets/8c34bf6e-4ca1-40e5-86e8-c7a35f304bb7)
## Features
- 🎥 **HLS Video Player** - Looping video player with hls.js support
- 🎨 **Sci-Fi Dark Theme** - Immersive dark theme with cyan/blue accents
- 👥 **Live Viewer Count** - Real-time viewer count with animated indicator
- 💬 **Chat Sidebar** - Interactive chat interface for viewer engagement
- 🎵 **Now Playing** - Metadata display for current track/content
- 📱 **Responsive Design** - Works seamlessly on desktop and mobile
## Tech Stack
- **Framework**: Next.js 16.1.6 with TypeScript
- **Styling**: Tailwind CSS 4
- **Video Player**: hls.js for HLS streaming
- **UI**: React 19.2.3 with modern hooks
## Getting Started
### Prerequisites
- Node.js 20.x or higher
- npm, yarn, pnpm, or bun
### Installation
1. Clone the repository:
```bash
git clone https://github.com/AeThex-LABS/aethex.live.git
cd aethex.live
```
2. Install dependencies:
```bash
npm install
```
3. Run the development server:
```bash
npm run dev
```
4. Open [http://localhost:3000](http://localhost:3000) in your browser.
### Configuration
To use your own HLS stream, edit `app/page.tsx` and update the `streamUrl` variable:
```typescript
const streamUrl = 'YOUR_HLS_STREAM_URL.m3u8';
```
## Build
Create an optimized production build:
```bash
npm run build
npm start
```
## Scripts
- `npm run dev` - Start development server
- `npm run build` - Create production build
- `npm start` - Start production server
- `npm run lint` - Run ESLint
## Project Structure
```
aethex.live/
├── app/
│ ├── page.tsx # Main page component
│ ├── layout.tsx # Root layout
│ └── globals.css # Global styles
├── components/
│ ├── HLSPlayer.tsx # Video player component
│ ├── ViewerCount.tsx # Viewer counter
│ ├── NowPlaying.tsx # Metadata display
│ └── ChatSidebar.tsx # Chat interface
└── public/ # Static assets
```
## License
© 2026 AeThex LABS - All rights reserved
## Deploy on Vercel
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/AeThex-LABS/aethex.live)
The easiest way to deploy is using the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme).
Check out the [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.