Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.

README.md

Latest commit

 

History

History
208 lines (149 loc) · 6.86 KB

README.md

File metadata and controls

208 lines (149 loc) · 6.86 KB
Raw

💵 TweeDollar

Warning

Este projeto foi descontinuado. A partir de março de 2026, o plano gratuito (free tier) da API/SDK do X (Twitter) foi encerrado. Como o TweeDollar era um projeto pessoal e de estudos, sem fins lucrativos, não é viável arcar com os custos da API paga. Por esse motivo, o bot foi oficialmente descontinuado e não receberá mais atualizações. O repositório permanecerá público como referência.


TweeDollar é um bot desenvolvido em Node.js e TypeScript que monitora a cotação do dólar (USD/BRL) utilizando a AwesomeAPI e publica automaticamente atualizações na plataforma X (antigo Twitter). 🐦

Acesso • Funcionalidades • Requisitos • Instalação • Execução • Estrutura • Contribuindo • Licença • Autor

🔗 Acesso

Acompanhe as atualizações da cotação do dólar em tempo real:

✨ Funcionalidades

🔄 Consulta Periódica: Monitoramento automático da cotação do dólar via AwesomeAPI
📊 Análise de Dados: Processamento das informações de cotação em tempo real
📤 Publicação Automática: Posts automáticos com atualizações na plataforma X (Twitter)
⚙️ Tecnologia Moderna: Desenvolvido com Node.js e TypeScript para maior robustez
☁️ Hospedagem Confiável: Serviço hospedado via Render como cron job

📦 Requisitos

  • 🟩 Node.js v18 ou superior
  • 📦 Gerenciador de pacotes pnpm
  • 🔑 Credenciais da API da plataforma X (Twitter)

🚀 Instalação

1. Clone o repositório:

git clone https://github.com/josevitorsoares/twee-dollar.git
cd twee-dollar

2. Instale as dependências:

pnpm install

3. Configure as variáveis de ambiente:

Crie um arquivo .env na raiz do projeto com base no .env.example.

cp .env.example .env

Edite o arquivo .env com suas credenciais da API da plataforma X:

# Configurações da API
API_PORT=3333

# URL para chamadas à Awesome API
EXTERNAL_API="https://economia.awesomeapi.com.br/json/last/usd"

# Credenciais da API do Twitter (X)
TWITTER_API_KEY=sua_api_key
TWITTER_API_SECRET=seu_api_secret
TWITTER_ACCESS_TOKEN=seu_access_token
TWITTER_ACCESS_SECRET=seu_access_secret

# Localização da imagem de um dólar
IMAGE_DOLLAR_PATH="./assets/images/dollar.jpg"

# Configurações de agendamento (formato cron)
CRON_SCHEDULE="0 */5 * * * *"  # A cada 5 minutos

▶️ Execução

Para iniciar o bot em seu ambiente local:

pnpm start

O bot verificará periodicamente a cotação do dólar e postará atualizações no Twitter automaticamente, de acordo com a programação definida no arquivo .env. 📈

Exemplo de post

🚨 ALTERAÇÃO NO DÓLAR 🚨

🚀 Dólar subindo que nem boleto no fim do mês
💵 Agora: R$ 5,87 às 15:05
📈 Subiu +0.05 (+0.86%)
📲 Segue o bot pra não perder nada!

🗂 Estrutura do Projeto

  • src/: Código-fonte principal
  • configs/: Arquivos de configuração
  • assets/: Imagens e recursos estáticos
  • server.ts: Ponto de entrada do servidor

🤝 Contribuindo

Contribuições são super bem-vindas! Se quiser reportar um bug, sugerir uma melhoria ou abrir um pull request, é só seguir os passos:

  1. Faça um fork do repositório
  2. Crie uma branch: git checkout -b minha-feature
  3. Faça suas alterações e commit: git commit -m 'feat: minha nova feature'
  4. Envie a branch: git push origin minha-feature
  5. Abra um Pull Request aqui no GitHub

🏷️ Convenções de Commit

Este projeto segue as convenções de Conventional Commits:

  • ✨ feat: Nova funcionalidade
  • 🐛 fix: Correção de bug
  • 📚 docs: Alterações na documentação
  • 💄 style: Formatação, ponto e vírgula, etc; sem alteração de código
  • ♻️ refactor: Refatoração de código
  • 🧪 test: Adição ou correção de testes
  • 🔧 chore: Alterações no processo de build, ferramentas, etc.

📄 Licença

Este projeto está licenciado sob a Licença Apache 2.0. 📝

⚠️ Descontinuação

O TweeDollar foi descontinuado em março de 2026.

O motivo principal foi o encerramento do plano gratuito da API/SDK do X (Twitter). Anteriormente, era possível utilizar a API para publicar tweets sem custo, o que viabilizava o funcionamento do bot. Com a remoção do free tier, qualquer acesso à API passou a exigir uma assinatura paga, inviabilizando a manutenção de um projeto pessoal e sem fins lucrativos como este.

O repositório permanecerá público para que possa servir de referência e aprendizado para quem tiver interesse na arquitetura, no uso da AwesomeAPI ou na estrutura do projeto.

💡 Autor

Feito com 💜 por José Vitor G. Soares