Skip to content

Latest commit

 

History

History
304 lines (204 loc) · 9.08 KB

File metadata and controls

304 lines (204 loc) · 9.08 KB

OpenCodeHub Documentation

OpenCodeHub Logo

Everything you need to know about OpenCodeHub - from getting started to advanced features

Welcome to OpenCodeHub's comprehensive documentation. Whether you're new to the platform or looking to master advanced features, you'll find everything you need here.


🚀 Quick Links

Install and set up OpenCodeHub in 5 minutes

Learn about stacked PRs, AI review, and more

Hands-on guides to master OpenCodeHub

Integrate with OpenCodeHub programmatically


📖 Documentation Sections

Getting Started

New to OpenCodeHub? Start here!

Core Features

Learn about OpenCodeHub's powerful features:

Hands-On Tutorials

Step-by-step guides to master OpenCodeHub:

Guides

Best practices and workflows:

API Reference

Integrate OpenCodeHub into your tools:

Administration

For system administrators:

Development

Contributing to OpenCodeHub:

Reference & Support


🎯 Popular Topics

Stacked Pull Requests

The #1 feature that makes OpenCodeHub unique:

main branch
 └── PR #123: Add database schema ✅
      └── PR #124: Add auth service  🔍
           └── PR #125: Add login UI ⏳

AI Code Review

Catch bugs before they reach production:

# AI Review finds:
# 🔴 CRITICAL: SQL injection on line 45
# 🟡 WARNING: N+1 query on line 128
# 🔵 INFO: Consider error handling on line 87

Merge Queue

Merge automatically, in the right order:

och queue add 123 124 125
# → Queue handles everything:
#    - CI runs
#    - Rebasing
#    - Merging in order
#    - Zero manual work

🔧 Installation

Quick Start (Docker)

# 1. Download docker-compose.yml
curl -O https://raw.githubusercontent.com/swadhinbiswas/OpencodeHub/main/docker-compose.yml

# 2. Configure
cp .env.example .env
# Edit .env with your settings

# 3. Start
docker-compose up -d

# 4. Create admin user
docker-compose exec app bun run scripts/seed-admin.ts

# 5. Open
open http://localhost:3000

Full installation guide →

Requirements

  • Docker: 20.10+ (recommended)
  • OR Node.js: 18+ with Bun or npm
  • Database: PostgreSQL 14+ or SQLite
  • Storage: Local, S3, Google Cloud Storage, or Azure Blob

🎓 Learning Paths

For Developers

  1. Quick Start - Get familiar with the platform
  2. Your First Stack - Learn stacked PRs
  3. Team Workflows - Collaborate effectively

For Teams

  1. Installation - Set up your instance
  2. Team Workflows - Define your process
  3. Branch Protection - Secure your code
  4. CI/CD Setup - Automate everything

For Administrators

  1. Deployment Guide - Production setup
  2. Security Best Practices - Secure your instance
  3. Monitoring - Track health
  4. Configuration - Tune performance

💬 Community & Support

Get Help

  • 📖 Documentation - You're here!
  • 💬 Discord - Real-time chat, community support
  • 🐛 GitHub Issues - Bug reports, feature requests
  • 📧 Email Support - Direct support

Contributing

We welcome contributions!


📝 Recent Updates

December 2024

  • ✨ Added AI code review with GPT-4 and Claude support
  • 🚀 Improved merge queue performance (60% faster)
  • 📊 New developer metrics dashboard
  • 🔧 100+ bug fixes and improvements

Full changelog →


🌟 Why OpenCodeHub?

Feature GitHub GitLab OpenCodeHub
Stacked PRs ✅ Native support
AI Code Review ⚠️ Copilot only ✅ GPT-4 & Claude
Smart Merge Queue ⚠️ Basic ⚠️ Basic ✅ Stack-aware
Self-Hosted ✅ Complex ✅ Simple
Cost $$$ $$$ Free

🔍 Search Documentation

Can't find what you're looking for?


📄 License

OpenCodeHub is open source under the MIT License.

View license →


Ready to get started?

Install OpenCodeHub → | Quick Start → | Your First Stack →