oiov
66 lines
1.9 KiB
Plaintext
66 lines
1.9 KiB
Plaintext
---
|
|
title: Introduction
|
|
description: Welcome to the WR.DO documentation.
|
|
---
|
|
|
|
## Features
|
|
|
|
- 🔗 **URL Shortening:** Generate short links with visitor analytic and password(support api)
|
|
- 📮 **Email Support:** Receive emails and send emails(support api)
|
|
- 💬 **P2P Chat:** Start chat in seconds
|
|
- 🌐 **Multi-Tenant Support:** Manage multiple DNS records seamlessly
|
|
- 📸 **Screenshot API:** Access to screenshot api、website meta-info scraping api.
|
|
- 😀 **Permission Management:** A convenient admin panel for auditing
|
|
- 🔒 **Secure & Reliable:** Built on Cloudflare's robust DNS API
|
|
|
|
## Screenshots
|
|
|
|
<img className="rounded-xl border mt-4 md:rounded-lg shadow-md" src="/_static/images/light-preview.png"/>
|
|
|
|
<img className="rounded-xl border mt-4 md:rounded-lg shadow-md" src="/_static/images/example_02.png"/>
|
|
|
|
<img className="rounded-xl border mt-4 md:rounded-lg shadow-md" src="/_static/images/example_01.png"/>
|
|
|
|
<img className="rounded-xl border mt-4 md:rounded-lg shadow-md" src="/_static/images/example_03.png"/>
|
|
|
|
## Quick Start
|
|
|
|
See docs about [guide](/docs/quick-start) for quick start.
|
|
|
|
## Self-hosted Tutorial
|
|
|
|
See step by step installation tutorial at [Quick Start for Developer](https://wr.do/docs/developer/quick-start).
|
|
|
|
### Requirements
|
|
|
|
- [Vercel](https://vercel.com) to deploy app
|
|
- [Cloudflare](https://dash.cloudflare.com/) account
|
|
- A **domain** name hosted on Cloudflare
|
|
|
|
See docs about [developer](/docs/developer/installation).
|
|
|
|
## Local development
|
|
|
|
copy `.env.example` to `.env` and fill in the necessary environment variables.
|
|
|
|
```bash
|
|
git clone https://github.com/oiov/wr.do
|
|
cd wr.do
|
|
pnpm install
|
|
|
|
# run on localhost:3000
|
|
pnpm dev
|
|
```
|
|
|
|
## Community Group
|
|
|
|
- Discord: https://discord.gg/d68kWCBDEs
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/oiov/wr.do/LICENSE.md)
|
|
|
|
## Star History
|
|
|
|
[](https://star-history.com/#oiov/wr.do&Date)
|