GitHub - aligundogdu/RetroRTC: Backend-free WebRTC-based retrospective tool

🎯 RetroRTC

Serverless, Privacy-First Retrospective Tool
Sunucusuz, Gizlilik Odaklı Retrospektif Aracı

🇺🇸 English | 🇹🇷 Türkçe

🇺🇸 English

📜 Manifesto

"Your ideas are yours. Your data should be too."

RetroRTC is designed to let teams run their retrospective meetings freely. A tool that prioritizes privacy, supports multiple synchronization methods, and doesn't require central servers, third-party services, or registration forms.

Why RetroRTC?

• 🔒 Privacy First: No data is sent to our servers by default. P2P modes allow data to live only in participants' browsers.
• 🎭 Anonymous Participation: Share your ideas freely with fun nicknames like "Cosmic Panda 42" or "Ninja Unicorn 7".
• ⚡ Zero Setup: No registration, no downloads, no configuration. Just share a link and start.
• 🌐 Flexible Sync: Choose between WebRTC (P2P), Trystero (BitTorrent), or Supabase (Realtime) based on your network needs.
• 💾 Full Control: Retrospective data stays in your browser. Delete or export anytime you want.

✨ Features

🎮 How It Works?

┌─────────────────────────────────────────────────────────────────┐
│                      RETROSPECTIVE FLOW                         │
└─────────────────────────────────────────────────────────────────┘

  1️⃣ CREATE                2️⃣ SHARE                3️⃣ JOIN
  ┌─────────┐              ┌─────────┐             ┌─────────┐
  │  Host   │    Link      │  Team   │   Click    │  Join   │
  │ Creates │ ──────────▶  │ Members │ ─────────▶ │   As    │
  │  Retro  │              │         │            │  Guest  │
  └─────────┘              └─────────┘             └─────────┘
       │                                                │
       │                                                │
       ▼                                                ▼
  ┌─────────────────────────────────────────────────────────┐
  │                  4️⃣ START THE RETRO!                     │
  │                                                         │
  │  ┌──────────┐  ┌──────────────┐  ┌──────────────────┐  │
  │  │ What     │  │ What Could   │  │ Action           │  │
  │  │ Went     │  │ Be           │  │ Items            │  │
  │  │ Well     │  │ Improved     │  │                  │  │
  │  │ 📝 Note 1│  │ 📝 Note 3    │  │ 📝 Note 5        │  │
  │  │ 📝 Note 2│  │ 📝 Note 4    │  │ 📝 Note 6        │  │
  │  └──────────┘  └──────────────┘  └──────────────────┘  │
  └─────────────────────────────────────────────────────────┘
                              │
                              ▼
                    5️⃣ EXPORT (Markdown)

Step by Step Usage

1. Create a Retrospective

   • Fill out the "Create New Retrospective" form on the home page.
   • Enter a retrospective name.
   • Choose default language (TR/EN).
   • Select Sync Provider:
     • PeerJS / Trystero: Best for open networks (P2P).
     • Supabase: Best for restrictive networks (VPNs/Firewalls). You can provide your own Supabase credentials!
   • Customize columns.

2. Share the Link

   • Share the unique generated link with team members.

3. Add Notes & Discuss

   • Add notes, edit them, and vote on others' ideas.
   • Everything syncs in real-time.

4. Export Results

   • Download the board as a Markdown file.

🛠 Tech Stack

🚀 Installation & Running

Requirements

• Node.js 18+
• npm, pnpm, yarn, or bun

Development

# Install dependencies
npm install

# Start development server (http://localhost:3000)
npm run dev

Production Build

# Create production build
npm run build

# Preview build
npm run preview

🇹🇷 Türkçe

📜 Manifesto

"Fikirleriniz sizin. Verileriniz de sizin olmalı."

RetroRTC, takımların retrospektif toplantılarını özgürce yapabilmesi için tasarlandı. Gizliliği ön planda tutan, farklı senkronizasyon yöntemlerini destekleyen, merkezi sunuculara veya kayıtlara ihtiyaç duymayan bir araç.

Neden RetroRTC?

• 🔒 Gizlilik Öncelikli: Varsayılan olarak sunucularımıza veri gönderilmez. P2P modları verilerin sadece tarayıcıda kalmasını sağlar.
• 🎭 Anonim Katılım: "Kozmik Panda 42" gibi eğlenceli takma isimlerle fikirlerinizi özgürce paylaşın.
• ⚡ Sıfır Kurulum: Kayıt yok, indirme yok. Sadece link paylaşın ve başlayın.
• 🌐 Esnek Senkronizasyon: Ağ durumunuza göre WebRTC (P2P), Trystero (BitTorrent) veya Supabase (Realtime) seçebilirsiniz.
• 💾 Tam Kontrol: Veriler tarayıcınızda kalır. İstediğiniz zaman silin, dışa aktarın.

✨ Özellikler

🎮 Nasıl Çalışır?

┌─────────────────────────────────────────────────────────────────┐
│                        RETROSPEKTİF AKIŞI                       │
└─────────────────────────────────────────────────────────────────┘

  1️⃣ OLUŞTUR                2️⃣ PAYLAŞ               3️⃣ KATIL
  ┌─────────┐              ┌─────────┐             ┌─────────┐
  │  Host   │    Link      │ Takım   │   Tıkla    │  Guest  │
  │ Retro   │ ──────────▶  │ Üyeleri │ ─────────▶ │  Olarak │
  │ Oluştur │              │   İle   │            │  Katıl  │
  └─────────┘              └─────────┘             └─────────┘
       │                                                │
       │                                                │
       ▼                                                ▼
  ┌─────────────────────────────────────────────────────────┐
  │                   4️⃣ RETRO BAŞLASIN!                     │
  │                                                         │
  │  ┌──────────┐  ┌──────────────┐  ┌──────────────────┐  │
  │  │ İyi      │  │ Geliştirilmesi│  │ Aksiyon         │  │
  │  │ Gidenler │  │ Gerekenler    │  │ Maddeleri       │  │
  │  │          │  │               │  │                 │  │
  │  │ 📝 Not 1 │  │ 📝 Not 3      │  │ 📝 Not 5        │  │
  │  │ 📝 Not 2 │  │ 📝 Not 4      │  │ 📝 Not 6        │  │
  │  └──────────┘  └──────────────┘  └──────────────────┘  │
  └─────────────────────────────────────────────────────────┘
                              │
                              ▼
                    5️⃣ EXPORT AL (Markdown)

Adım Adım Kullanım

1. Retrospektif Oluştur

   • Ana sayfadaki formu doldurun.
   • Dil seçiminizi yapın (TR/EN).
   • Bağlantı Yöntemi seçin:
     • PeerJS / Trystero: Açık ağlar için ideal (P2P).
     • Supabase: Kısıtlı ağlar (VPN/Güvenlik Duvarı) için ideal. Kendi Supabase bilgilerinizi girebilirsiniz!
   • Kolonları özelleştirin.

2. Linki Paylaş

   • Oluşturulan linki takımla paylaşın.

3. Notlar Ekle & Tartış

   • Not ekleyin, düzenleyin, oylayın.
   • Her şey anlık senkronize olur.

4. Sonuçları Dışa Aktar

   • Markdown formatında indirin.

🛠 Teknoloji Stack

🚀 Kurulum ve Çalıştırma

Gereksinimler

• Node.js 18+
• npm, pnpm, yarn veya bun

Geliştirme Ortamı

# Bağımlılıkları yükle
npm install

# Geliştirme sunucusunu başlat (http://localhost:3000)
npm run dev

Production Build

# Production build oluştur
npm run build

# Build'i önizle
npm run preview

🤝 Contributing / Katkıda Bulunma

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

📄 License / Lisans

This project is licensed under the MIT License. Bu proje MIT lisansı altında lisanslanmıştır.

🎯 RetroRTC
Your data is yours, your ideas are free.
Verileriniz sizin, fikirleriniz özgür.