Skip to content

Latest commit

 

History

History
207 lines (160 loc) · 8.01 KB

README.md

File metadata and controls

207 lines (160 loc) · 8.01 KB

🎬 GoRec - Browser-Based Screen Recorder

CI Release License PRs Welcome

A powerful, modern screen recording application built with React and TypeScript. Record your screen, webcam, and audio directly from your browser with seamless cloud storage integration.

React TypeScript Vite Tailwind CSS Supabase

✨ Features

  • 🖥️ Screen Recording - Capture your entire screen, specific windows, or browser tabs
  • 📹 Webcam Support - Record with picture-in-picture webcam overlay
  • 🎤 Audio Recording - Capture system audio and microphone input
  • ☁️ Cloud Storage - Automatically upload recordings to Supabase Storage
  • 🔗 Easy Sharing - Generate shareable links for your recordings
  • 📱 Responsive Design - Works on desktop and tablet devices
  • �� Multi-language - English and Arabic (RTL) support
  • 🔐 Authentication - Secure user accounts with Supabase Auth
  • 📜 Recording History - View and manage all your past recordings

🚀 Quick Start

Prerequisites

  • Node.js 18+
  • pnpm package manager
  • Supabase account (for backend services)

Installation

  1. Clone the repository

    git clone https://github.com/Abdelkaderbzz/screen-recorder.git
    cd screen-recorder
  2. Install dependencies

    pnpm install
  3. Set up environment variables

    cp .env.example .env

    Edit .env with your Supabase credentials:

    VITE_SUPABASE_URL=your_supabase_url
    VITE_SUPABASE_PUBLISHABLE_KEY=your_supabase_anon_key
    VITE_SUPABASE_PROJECT_ID=your_project_id
  4. Start development server

    pnpm dev
  5. Open your browser Navigate to http://localhost:5173

📁 Project Structure

src/
├── components/           # React components
│   ├── ui/              # Reusable UI components (shadcn/ui)
│   ├── shared/          # Shared layout components
│   └── recorder/        # Recording-specific components
├── contexts/            # React Context providers
│   ├── AuthContext.tsx  # Authentication state
│   └── RecordingContext.tsx  # Recording state management
├── hooks/               # Custom React hooks
│   ├── useScreenCapture.ts   # Screen capture logic
│   ├── useMediaRecorder.ts   # MediaRecorder API wrapper
│   ├── useWebcam.ts          # Webcam access
│   ├── useAudioDevices.ts    # Audio device management
│   ├── useVideoUpload.ts     # Upload functionality
│   └── useRecordingsHistory.ts  # Recording history
├── i18n/                # Internationalization
│   ├── en.ts           # English translations
│   ├── ar.ts           # Arabic translations
│   └── I18nProvider.tsx # i18n context
├── integrations/        # External service integrations
│   └── supabase/       # Supabase client & types
├── lib/                 # Utility functions
├── pages/               # Route pages
│   ├── Landing.tsx     # Home page
│   ├── Recorder.tsx    # Main recorder page
│   ├── Auth.tsx        # Authentication page
│   ├── AuthCallback.tsx # OAuth callback handler
│   ├── Profile.tsx     # User profile page
│   ├── Watch.tsx       # Video playback page
│   └── NotFound.tsx    # 404 page
└── App.tsx             # Root component with routing

🛠️ Tech Stack

Frontend

  • React 18 - UI library with hooks
  • TypeScript - Type safety
  • Vite - Fast build tool
  • Tailwind CSS - Utility-first styling
  • shadcn/ui - Accessible UI components
  • React Router - Client-side routing
  • React Query - Data fetching & caching
  • React Hook Form - Form management
  • Zod - Schema validation

Backend

  • Supabase - Backend as a Service
    • PostgreSQL database
    • Authentication
    • File storage
    • Row Level Security

Media APIs

  • MediaDevices API - Screen & webcam capture
  • MediaRecorder API - Recording functionality
  • Web Audio API - Audio processing

📜 Available Scripts

Command Description
pnpm dev Start development server
pnpm build Build for production
pnpm build:dev Build for development
pnpm preview Preview production build
pnpm lint Run ESLint
pnpm lint:fix Run ESLint with auto-fix
pnpm typecheck Run TypeScript type checking
pnpm security:audit Run security audit script
pnpm release Build and run security audit

🤝 Contributing

We welcome contributions from everyone! Please read our Contributing Guide and Code of Conduct before submitting a pull request.

  • Fork the repository
  • Create a feature branch (git checkout -b feature/amazing-feature)
  • Commit your changes (git commit -m 'feat: add amazing feature')
  • Push to the branch (git push origin feature/amazing-feature)
  • Open a Pull Request

For detailed guidelines, see docs/CONTRIBUTING.md.

📚 Documentation

🌐 Routes

Path Component Description
/ Landing Home page
/auth Auth Login/Register
/auth/callback AuthCallback OAuth callback handler
/recorder Recorder Recording interface
/profile Profile User profile management
/watch/:token Watch Shared video playback
* NotFound 404 page

🔒 Environment Variables

Variable Required Description
VITE_SUPABASE_URL ✅ Supabase project URL
VITE_SUPABASE_PUBLISHABLE_KEY ✅ Supabase anon/public key
VITE_SUPABASE_PROJECT_ID ✅ Supabase project ID

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments


Made with ❤️ by Abdelkader Bouzomita