oiov
97 lines
2.9 KiB
Markdown
97 lines
2.9 KiB
Markdown
<div align="center">
|
|
<h1>WR.DO</h1>
|
|
<p><a href="https://discord.gg/AHPQYuZu3m">Discord</a> · English | <a href="/README-zh.md">简体中文</a></p>
|
|
<p>生成短链接, 创建 DNS 记录, 管理临时邮箱</p>
|
|
<!-- <img src="https://wr.do/_static/images/light-preview.png"/> -->
|
|
</div>
|
|
|
|
## 功能
|
|
|
|
- 🔗 **短链生成**：生成附有访问者统计信息的短链接 (支持密码保护, 支持调用 API)
|
|
- 📮 **临时邮箱**：创建多个临时邮箱接收和发送邮件（支持调用 API）
|
|
- 🌐 **多租户支持**：无缝管理多个 DNS 记录
|
|
- 📸 **截图 API**：访问截图 API、网站元数据抓取 API
|
|
- �😀 **权限管理**：方便审核的管理员面板
|
|
- 🔒 **安全可靠**：基于 Cloudflare 强大的 DNS API
|
|
|
|
## 截图预览
|
|
|
|
<table>
|
|
<tr>
|
|
<td><img src="https://wr.do/_static/images/light-preview.png" /></td>
|
|
<td><img src="https://wr.do/_static/images/example_02.png" /></td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="https://wr.do/_static/images/example_01.png" /></td>
|
|
<td><img src="https://wr.do/_static/images/realtime-globe.png" /></td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="https://wr.do/_static/images/example_03.png" /></td>
|
|
<td><img src="https://wr.do/_static/images/domains.png" /></td>
|
|
</tr>
|
|
</table>
|
|
|
|
## 快速开始
|
|
|
|
查看开发者[快速开始](https://wr.do/docs/developer/quick-start)详细文档。
|
|
|
|
## 自部署教程
|
|
|
|
### 使用 Vercel 部署
|
|
|
|
[](https://vercel.com/new/clone?repository-url=https://github.com/oiov/wr.do.git&project-name=wrdo&env=DATABASE_URL&env=AUTH_SECRET&env=RESEND_API_KEY&env=NEXT_PUBLIC_EMAIL_R2_DOMAIN&env=NEXT_PUBLIC_OPEN_SIGNUP&env=GITHUB_TOKEN)
|
|
|
|
记得填写必要的环境变量。
|
|
|
|
### 使用 Docker Compose 部署
|
|
|
|
在服务器中创建一个文件夹，进入该文件夹并新建`docker-compose.yml`文件，填写必要的环境变量，然后执行：
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
## 本地开发
|
|
|
|
将 `.env.example` 复制为 `.env` 并填写必要的环境变量。
|
|
|
|
```bash
|
|
git clone https://github.com/oiov/wr.do
|
|
cd wr.do
|
|
pnpm install
|
|
|
|
# 在 localhost:3000 上运行
|
|
pnpm dev
|
|
```
|
|
|
|
#### 初始化数据库
|
|
|
|
```bash
|
|
pnpm postinstall
|
|
pnpm db:push
|
|
```
|
|
|
|
#### 管理员初始化
|
|
|
|
Follow https://localhost:3000/setup
|
|
|
|
## 社区群组
|
|
|
|
- Discord: https://discord.gg/AHPQYuZu3m
|
|
- 微信群：
|
|
|
|
|
|
|
|
## 许可证
|
|
|
|
[MIT](/LICENSE.md)
|
|
|
|
## Star History
|
|
|
|
<a href="https://star-history.com/#oiov/wr.do&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=oiov/wr.do&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=oiov/wr.do&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=oiov/wr.do&type=Date" />
|
|
</picture>
|
|
</a> |