Skip to content

Commit 5838091

Browse files
committed
chore: Change README
1 parent 4905f5b commit 5838091

File tree

1 file changed

+47
-8
lines changed

1 file changed

+47
-8
lines changed

README.md

+47-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,58 @@
11
# BSky Repost Bot
22

3-
Esse é o repositório do Bot de Repost para o BlueSky da comunidade.dev.br.
3+
Esse é o repositório do Bot de Repost para o BlueSky da [comunidade.dev.br](comunidade.dev.br).
44

55
## Funcionalidades
66

7-
| | Dev | Beta | Pronto |
8-
| --------------------- | ------------------ | ------------------ | ------ |
9-
| Repost menção | | :heavy_check_mark: | |
10-
| Repost #bolhatech | :heavy_check_mark: | | |
11-
| Repost #comunidadedev | :heavy_check_mark: | | |
7+
| | Dev | Beta | Pronto |
8+
| ------------------------- | --- | ------------------ | ------ |
9+
| Marcar @comunidade.dev.br | | :heavy_check_mark: | |
10+
| Repost #bolhatech | | :heavy_check_mark: | |
11+
| Repost #bolhadev | | :heavy_check_mark: | |
12+
| Repost #comunidadedev | | :heavy_check_mark: | |
1213

1314
## Para usar
1415

15-
Mencione `@comunidade.dev.br` ou ~~use as tags `#bolhatech` ou `#comunidadedev`~~.
16+
Mencione `@comunidade.dev.br` ou use as tags `#bolhatech`, `#bolhadev` ou `#comunidadedev`.
17+
18+
## Como o bot funciona?
19+
20+
A cada 15 minutos o bot percorre as notificações da conta @comunidade.dev.br para
21+
dar repost nos posts em que foi marcado.
22+
23+
Também busca pelos posts com a tags acima.
24+
25+
Aplicamos filtros na busca para evitar repost de assuntos polêmicos ou não relacionados
26+
a tecnologia.
1627

1728
## Quer colaborar?
1829

19-
> WIP: documentação sendo desenvolvida.
30+
Para executar o bot na sua máquina local é preciso instalar algumas ferramentas:
31+
32+
- [Docker Desktop](https://www.docker.com/products/docker-desktop) ou [Rancher Desktop](https://rancherdesktop.io/)
33+
- [Deno](https://deno.land/)
34+
- [Supabase CLI](https://supabase.io/docs/guides/cli)
35+
36+
Copie o arquivo `.env.example` para `.env` e preencha as variáveis de ambiente.
37+
38+
```bash
39+
cp .env.example .env
40+
```
41+
42+
Execute o ambiente Supabase.
43+
44+
```bash
45+
supabase start
46+
```
47+
48+
Suba o ambiente Upstash.
49+
50+
```bash
51+
docker compose up -d
52+
```
53+
54+
Execute o bot.
55+
56+
```bash
57+
supabase functions serve --no-verify-jwt --env-file .env
58+
```

0 commit comments

Comments
 (0)