- Project Overview - Brief description of the video conferencing application
- Prerequisites - Required software (Node.js, pnpm, Git)
- Environment Setup - Step-by-step installation and configuration
- Environment Variables - Detailed configuration for both client and server
- Running Instructions - Development and production modes
- Project Structure - Clear overview of the codebase organization
- Available Scripts - All npm/pnpm commands for both client and server
- Network Configuration - Development vs production settings
- Authentication Setup - Clerk integration guidance
- Troubleshooting - Common issues and solutions
- Contributing Guidelines - How to contribute to the project
Server (.env):
PORT=3001- Server portLISTEN_IP=0.0.0.0- Network interface to listen onANNOUNCED_IP=127.0.0.1- IP address to announce to clients
Client (.env):
VITE_SERVER_URL=http://localhost:3001- Server URL for WebSocket connectionsVITE_CLERK_PUBLISHABLE_KEY=yourclerk-key- Server URL for WebSocket connections
The README provides clear instructions for contributors to:
- Clone and install dependencies
- Set up environment variables
- Run the application in development mode
- Build for production