Complete documentation is available at /static/docs or visit the live docs site.
Quick links:
- Getting Started - Installation and setup
- Deployment Guide - Production deployment
- API Documentation - REST API reference
- Development Guide - Architecture and contributing
- Changelog - Version history
Quiest start with CloudFlare Workers Deploy
# Clone and install
git clone https://github.com/clarkhacks/RdRx.git
cd RdRx
pnpm install
# Configure
cp .dev.vars.example .dev.vars
# Edit .dev.vars with your settings
# Set up Cloudflare resources
wrangler d1 create rdrx-db
wrangler r2 bucket create rdrx-files
wrangler kv:namespace create rdrx-kv
# Initialize database
wrangler d1 execute rdrx-db --file=./schema.sql
# Run development server
pnpm devVisit http://localhost:8787 to see your RdRx instance!
- URL Shortening - Create short, memorable links
- A/B Testing & Link Rotation - One URL, multiple destinations with round-robin, weighted, or random distribution
- Code Snippets - Share code with syntax highlighting
- File Sharing - Upload and share files securely
- Bio Pages - Create custom landing pages (like Linktree)
- Analytics - Track link performance and visitor data
- Password Protection - Secure your links with passwords
- Scheduled Deletion - Auto-delete links after a specified time
- API Access - Programmatic access via REST API
- Admin Panel - Comprehensive admin interface
- User Dashboard - Manage all your content in one place
Clean, modern landing page |
Comprehensive user dashboard |
- Runtime: Cloudflare Workers
- Database: Cloudflare D1 (SQLite)
- Storage: Cloudflare R2
- Cache: Cloudflare KV
- Language: TypeScript
- Build Tool: Wrangler
static/docs/
├── README.md # Documentation home
├── getting-started.md # Quick start guide
├── deployment.md # Production deployment
├── api-keys.md # API key management
├── changelog.md # Version history
├── contributing.md # Contribution guidelines
├── code-of-conduct.md # Community guidelines
├── production-ready.md # Production checklist
├── api/ # API documentation
│ └── README.md # REST API reference
└── development/ # Development docs
├── README.md # Architecture guide
├── refactoring-plan.md
├── phase1-summary.md
├── phase2-plan.md
├── ui-improvements.md
└── security-improvements.md
We welcome contributions! Please see our Contributing Guide for details.
This project is licensed under the GPL-3.0 License. See the LICENSE file for details.
If you find RdRx useful, please consider: