Skip to content

Latest commit

 

History

History
106 lines (66 loc) · 3.92 KB

Template.md

File metadata and controls

106 lines (66 loc) · 3.92 KB
Raw

Govinda Systems DAO - Ecomm Template

Cypress Tests Join our Slack! Netlify Status

Um template inicial para criar uma TWA (Telegram Web App) que interage com a blockchain TON.

Visão Geral

Este projeto é altamente opinativo, servindo como um ponto de partida para o desenvolvimento de aplicativos web no Telegram que interagem com a blockchain TON. Algumas características incluem:

  • Suporte a carteiras Ton Connect 2
  • Utiliza Vite com React (alternativa ao Create React App)
  • Usa o pacote ton do npm

Pré-requisitos

  • Node.js v16 (outras versões podem funcionar, mas precisam ser testadas)
  • Uma carteira compatível com Ton Connect (por exemplo, Tonkeeper)

O que este repositório contém?

  • Um aplicativo pronto para TWA baseado em React, interagindo com a TON
  • Configurações do GitHub Actions para implantar o app no GitHub Pages
  • Um script para conectar um bot do Telegram ao aplicativo implantado

Como Usar

  1. Crie um repositório a partir deste template usando o botão "Use this template"

    • Escolha um nome para o seu repositório

    • IMPORTANTE: Marque a opção "Include all branches" para que a implantação no GitHub Pages funcione corretamente.

      Incluir todas as branches

  2. Clone o repositório e instale as dependências

    git clone https://github.com/seu-usuario/seu-repositorio.git
cd seu-repositorio
yarn
# ou
npm install

2.1 Para executar a pipeline na sua máquina local execute o comando abaixo:

```bash
chmod +x pipeline.sh
```

  1. Crie um novo bot com o BotFather

    • Digite /newbot
    • Escolha um nome para o seu bot (ex: Meu Ecomm TWA)
    • Escolha um nome de usuário para o seu bot (ex: meu_ecomm_twa_bot)
    • Anote o token de acesso fornecido (ex: 123456789:ABCdefGHIjklMNOpqrSTUvwxYZ)
    • Execute yarn configbot ou npm run configbot para vincular seu bot ao aplicativo web

Criando um novo Web App no Telegram

  1. Inicie uma conversa com o BotFather e digite o comando /newapp.

    /newapp

  2. Selecione o bot que oferecerá o Web App:

    • Escolha o bot que você criou anteriormente (por exemplo: @govinda_systems_bot).

  3. Digite um título para o Web App:

    • Exemplo: Govinda Systems E-comm.

  4. Forneça uma breve descrição:

    • Exemplo: Template inicial de E-commerce utilizando TON blockchain e Telegram Web Apps (TWA).

  5. Envie uma imagem de visualização (dimensões recomendadas: 640x360 pixels).

    • Depois de completar esses passos, o Web App estará pronto para ser vinculado ao bot e usado dentro do Telegram.

Desenvolvimento

  1. Inicie o ambiente de desenvolvimento

    npm run dev

  2. Edite o código conforme necessário

    • O aplicativo recarregará automaticamente com as mudanças.

  3. Implantação automática

    • Ao fazer push para a branch main, o aplicativo será implantado automaticamente via GitHub Actions.

Contribuição

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou pull requests. Vamos construir juntos uma comunidade forte em torno deste projeto.

Licença

Este projeto está licenciado sob a Licença MIT.