Skip to content

Commit dcbd46a

Browse files
frkrfrkr
authored
Add multilingual READMEs with feature highlights (#64)
This PR adds comprehensive documentation for the Cloudflare Gateway project. It includes a main README.md in English and translated versions in Portuguese (pt-br) and Spanish (es), as per the project's documentation guidelines in AGENTS.md. The READMEs highlight the core features, technology stack, and provide basic instructions for installation, local development, and deployment. Fixes #63 --- *PR created automatically by Jules for task [17978290303800911235](https://jules.google.com/task/17978290303800911235) started by @frkr*
2 parents 72a195f + d6ba283 commit dcbd46a

3 files changed

Lines changed: 202 additions & 1 deletion

File tree

‎README.es.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Cloudflare Gateway
2+
3+
Cloudflare Gateway es una herramienta potente y ligera diseñada para almacenar, visualizar y reenviar (replay) solicitudes HTTP (webhooks). Construido sobre el ecosistema de Cloudflare, aprovecha servicios de alto rendimiento para proporcionar una solución escalable para la depuración y el monitoreo de comunicaciones asíncronas.
4+
5+
## 🚀 Características
6+
7+
- **Almacenamiento de Webhooks**: Captura y almacena solicitudes y respuestas HTTP entrantes.
8+
- **Reenvío de Mensajes**: Reintente y reenvíe mensajes fácilmente directamente desde el panel de control.
9+
- **Panel de Administración**: Una interfaz de usuario moderna construida con React Router 7 para visualizar registros y gestionar mensajes.
10+
- **Procesamiento Asíncrono**: Utiliza Cloudflare Queues para el procesamiento confiable de tareas en segundo plano.
11+
- **Almacenamiento Persistente**: Utiliza Cloudflare D1 para metadatos y R2 para el almacenamiento de contenido de gran tamaño.
12+
- **Limpieza Automática**: Incluye una tarea programada (Cron) para purgar datos antiguos basados en políticas de retención configurables.
13+
- **Seguridad**: Rutas protegidas mediante autenticación por Token de Administrador.
14+
15+
## 🛠 Tecnologías
16+
17+
- **Runtime**: Cloudflare Workers
18+
- **Base de Datos**: Cloudflare D1 (SQL)
19+
- **Almacenamiento de Objetos**: Cloudflare R2
20+
- **Mensajería**: Cloudflare Queues
21+
- **Frontend**: React Router 7, React 19, Tailwind CSS
22+
- **Herramienta de Construcción**: Vite
23+
- **Pruebas**: Vitest y Playwright
24+
25+
## 📥 Primeros Pasos
26+
27+
### Requisitos Previos
28+
29+
- [Node.js](https://nodejs.org/) (se recomienda la última versión LTS)
30+
- [pnpm](https://pnpm.io/)
31+
- [Wrangler](https://developers.cloudflare.com/workers/wrangler/install-and-update/)
32+
33+
### Instalación
34+
35+
1. Clone el repositorio.
36+
2. Instale las dependencias:
37+
```bash
38+
pnpm install
39+
```
40+
3. Inicialice la base de datos local:
41+
```bash
42+
pnpm wrangler d1 execute cfgateway --local --file=./path/to/schema.sql
43+
```
44+
45+
### Desarrollo Local
46+
47+
Ejecute el servidor de desarrollo:
48+
```bash
49+
pnpm run dev
50+
```
51+
52+
### Despliegue
53+
54+
Despliegue en Cloudflare Workers:
55+
```bash
56+
pnpm run deploy
57+
```
58+
59+
## ⚙️ Configuración
60+
61+
Las variables de entorno y los bindings se gestionan en `wrangler.jsonc`:
62+
63+
- `ADMIN_TOKEN`: Token de seguridad para acceder al panel.
64+
- `MAX_AGE_DAYS`: Período de retención de mensajes (por defecto: 30 días).
65+
66+
## 📄 Licencia
67+
68+
Este proyecto está bajo la Licencia MIT - vea el archivo [LICENSE](LICENSE) para más detalles.

‎README.md‎

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,68 @@
11
# Cloudflare Gateway
22

3-
Visualizer Tool for Webhook and Replays
3+
Cloudflare Gateway is a powerful and lightweight tool designed to store, visualize, and replay HTTP requests (webhooks). Built on top of the Cloudflare ecosystem, it leverages high-performance services to provide a scalable solution for debugging and monitoring asynchronous communications.
4+
5+
## 🚀 Features
6+
7+
- **Webhook Storage**: Captures and stores incoming HTTP requests and responses.
8+
- **Message Replay**: Easily retry and replay messages directly from the dashboard.
9+
- **Admin Panel**: A modern UI built with React Router 7 to visualize logs and manage messages.
10+
- **Asynchronous Processing**: Uses Cloudflare Queues for reliable, background processing of tasks.
11+
- **Persistent Storage**: Utilizes Cloudflare D1 for metadata and R2 for large content storage.
12+
- **Automated Cleanup**: Includes a scheduled task (Cron) to purge old data based on configurable retention policies.
13+
- **Security**: Protected routes via Admin Token authentication.
14+
15+
## 🛠 Tech Stack
16+
17+
- **Runtime**: Cloudflare Workers
18+
- **Database**: Cloudflare D1 (SQL)
19+
- **Object Storage**: Cloudflare R2
20+
- **Messaging**: Cloudflare Queues
21+
- **Frontend**: React Router 7, React 19, Tailwind CSS
22+
- **Build Tool**: Vite
23+
- **Testing**: Vitest & Playwright
24+
25+
## 📥 Getting Started
26+
27+
### Prerequisites
28+
29+
- [Node.js](https://nodejs.org/) (latest LTS recommended)
30+
- [pnpm](https://pnpm.io/)
31+
- [Wrangler](https://developers.cloudflare.com/workers/wrangler/install-and-update/)
32+
33+
### Installation
34+
35+
1. Clone the repository.
36+
2. Install dependencies:
37+
```bash
38+
pnpm install
39+
```
40+
3. Initialize the local database:
41+
```bash
42+
pnpm wrangler d1 execute cfgateway --local --file=./path/to/schema.sql
43+
```
44+
45+
### Local Development
46+
47+
Run the development server:
48+
```bash
49+
pnpm run dev
50+
```
51+
52+
### Deployment
53+
54+
Deploy to Cloudflare Workers:
55+
```bash
56+
pnpm run deploy
57+
```
58+
59+
## ⚙️ Configuration
60+
61+
Environment variables and bindings are managed in `wrangler.jsonc`:
62+
63+
- `ADMIN_TOKEN`: Security token for accessing the panel.
64+
- `MAX_AGE_DAYS`: Retention period for messages (default: 30 days).
65+
66+
## 📄 License
67+
68+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

‎README.pt-br.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Cloudflare Gateway
2+
3+
Cloudflare Gateway é uma ferramenta poderosa e leve projetada para armazenar, visualizar e reenviar (replay) requisições HTTP (webhooks). Construído sobre o ecossistema Cloudflare, ele utiliza serviços de alta performance para fornecer uma solução escalável para depuração e monitoramento de comunicações assíncronas.
4+
5+
## 🚀 Funcionalidades
6+
7+
- **Armazenamento de Webhooks**: Captura e armazena requisições e respostas HTTP recebidas.
8+
- **Replay de Mensagens**: Reenvie mensagens facilmente diretamente do painel de controle.
9+
- **Painel Administrativo**: Uma interface moderna construída com React Router 7 para visualizar logs e gerenciar mensagens.
10+
- **Processamento Assíncrono**: Utiliza Cloudflare Queues para processamento de tarefas em segundo plano de forma confiável.
11+
- **Armazenamento Persistente**: Utiliza Cloudflare D1 para metadados e R2 para armazenamento de grandes conteúdos.
12+
- **Limpeza Automática**: Inclui uma tarefa agendada (Cron) para remover dados antigos com base em políticas de retenção configuráveis.
13+
- **Segurança**: Rotas protegidas via autenticação por Admin Token.
14+
15+
## 🛠 Tecnologias
16+
17+
- **Runtime**: Cloudflare Workers
18+
- **Banco de Dados**: Cloudflare D1 (SQL)
19+
- **Armazenamento de Objetos**: Cloudflare R2
20+
- **Mensageria**: Cloudflare Queues
21+
- **Frontend**: React Router 7, React 19, Tailwind CSS
22+
- **Build Tool**: Vite
23+
- **Testes**: Vitest & Playwright
24+
25+
## 📥 Primeiros Passos
26+
27+
### Pré-requisitos
28+
29+
- [Node.js](https://nodejs.org/) (recomendado última versão LTS)
30+
- [pnpm](https://pnpm.io/)
31+
- [Wrangler](https://developers.cloudflare.com/workers/wrangler/install-and-update/)
32+
33+
### Instalação
34+
35+
1. Clone o repositório.
36+
2. Instale as dependências:
37+
```bash
38+
pnpm install
39+
```
40+
3. Inicialize o banco de dados local:
41+
```bash
42+
pnpm wrangler d1 execute cfgateway --local --file=./path/to/schema.sql
43+
```
44+
45+
### Desenvolvimento Local
46+
47+
Execute o servidor de desenvolvimento:
48+
```bash
49+
pnpm run dev
50+
```
51+
52+
### Deploy
53+
54+
Faça o deploy para o Cloudflare Workers:
55+
```bash
56+
pnpm run deploy
57+
```
58+
59+
## ⚙️ Configuração
60+
61+
As variáveis de ambiente e bindings são gerenciados no arquivo `wrangler.jsonc`:
62+
63+
- `ADMIN_TOKEN`: Token de segurança para acessar o painel.
64+
- `MAX_AGE_DAYS`: Período de retenção das mensagens (padrão: 30 dias).
65+
66+
## 📄 Licença
67+
68+
Este projeto está licenciado sob a Licença MIT - veja o arquivo [LICENSE](LICENSE) para mais detalhes.

0 commit comments

Comments
 (0)