KayTwenty / LiveVHS

A fully kitted live streaming platform with zero censorship

LiveVHS - FullStack Streaming Platform

Table of Contents

• Features
• Prerequisites
• Installation
• Prisma
• Docker
• Licensing

Features

• Live streaming with chat functionality
• Complete follow system
• Chat functionality for real-time interaction with viewers
• User authentication and authorization
• Analytics and viewer statistics

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18.17.1): Download
• Next.js (v14) Getting Started
• Prisma ORM with MySQL: Getting Started
• Tailwind CSS: Getting Started
• ShadCN UI Library: Getting Started
• Clerk for User Authentication: Getting Started

Installation

To run this project locally, follow these steps below:

Instructions

1. Clone the repository:

   git clone https://github.com/KayTwenty/LiveVHS.git

2. Navigate to the project directory:

   cd LiveVHS

3. Install the necessary dependencies:

   npm install
   # or
   yarn install

4. Install ngrok globally:

   npm install -g ngrok

5. Run the development server:

   npm run dev
   # or 
   yarn dev

6. Start ngrok tunnel:

   ngrok http 3000

The site should now be available at http://localhost:3000.

Prisma

Add PostgreSQL Database to .env

1. Generate the Prisma configuration

   npx prisma generate

2. Push the Prisma database file to your own database

   npx prisma db push

Docker

To run LiveVHS using Docker, follow these steps:

1. Build the Docker image:

   docker build -t my-livevhs-app:v1.0 .

2. Run the Docker container:

   docker run -p 3000:3000 \
   -e NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="your_publishable_key" \
   -e CLERK_SECRET_KEY="your_secret_key" \
   -e CLERK_WEBHOOK_SECRET="your_webhook_secret" \
   -e DATABASE_URL="postgresql://example" \
   my-livevhs-app:v1.0

License

This project currently has no license