1. Project Overview

WR.DO

Generate Short Links, Create DNS Records, Manage Temporary Email

WR.DO is an all-in-one domain services (SaaS) platform integrating short link generation, subdomain hosting, unlimited email services, and open API endpoints to unlock the full potential of your domain.

2. Open Source License

Licensed under MIT

3. Screenshots

Screenshot Preview

4. Feature Overview

Function

• Short Link Generation
  Generate short links with visitor analytics (password protection supported, API integration supported)
• Temporary Email
  Create multiple temporary email addresses to receive and send emails (API integration supported)
• Multi-tenant Support
  Seamlessly manage multiple DNS records
• Screenshot API
  Access the screenshot API and website metadata extraction API
• Permission ManagementAdmin panel for convenient management and review
• Secure and Reliable
  Powered by Cloudflare's powerful DNS API

Function List

Short Link Service:

• Support for custom short links
• Support for generating custom QR codes
• Support for password-protected links
• Support for setting expiration times
• Support for access analytics (real-time logs, maps, and other multidimensional data analysis)
• Support for creating short links via API

Temporary Email Service:

• Support for creating email addresses with custom prefixes
• Support for filtering unread emails
• Create an unlimited number of email addresses
• Support for receiving unlimited emails (requires Cloudflare Email Worker)
• Support for sending emails (requires Resend)
• Support for creating email addresses via API
• Support for retrieving inbox emails via API

Subdomain Management Service:

• Support for managing DNS records across multiple domains under multiple Cloudflare accounts
• Support for creating various DNS record types (CNAME, A, TXT, etc.)

Open API Module:

• Website metadata retrieval API
• Website screenshot API
• Website QR code generation API
• Convert websites to Markdown or Text
• Support for API call statistics and logs across all API types
• Support for generating user API Keys for third-party access to open APIs

Admin Module:

• Multidimensional charts for displaying website status
• Domain service configuration (dynamically enable or disable individual services, including short links, temporary email (sending and receiving), and subdomain management)
• User management (set permissions, allocate usage quotas, disable users, etc.)
• Short link management (manage short links created by all users)
• Email management (manage temporary email addresses created by all users)
• Subdomain management (manage subdomains created by all users)

5. Tech Stack

Quick Start

View the detailed Quick Start documentation for developers.

Requirements

• A Vercel account for deploying the application
• At least one domain

View the development documentation.

Email worker

View the Email Worker documentation for email reception.

Self-Hosting Tutorial

Deploy with Vercel

Remember to configure the required environment variables.

Deploy with Docker Compose

Create a folder on your server, navigate into it, and create a new docker-compose.yml file. Configure the required environment variables, then execute:

docker compose up -d

Local development

Copy .env.example to .env and configure the required environment variables.

git clone wr.do
cd wr.do
pnpm install

# Run on localhost:3000
pnpm dev

Initialize database

pnpm postinstall
pnpm db:push

Administrator Initialization

Follow https://localhost:3000/setup