Skip to content

🚀 nation.fun!

Um projeto modelo para conectar agentes e criar novos de forma simples e elegante

MIT License GitHub stars GitHub forks

Doc Site

📋 Sobre o Projeto

nation.fun é uma plataforma inovadora e bem estruturada que funciona como um projeto modelo para conectar com agentes inteligentes e criar novos agentes de forma prática e eficiente. Este projeto foi desenvolvido com as melhores práticas de engenharia de software, incluindo testes unitários, BDD (Behavior-Driven Development), integração com Next.js e hospedagem via GitHub Pages.

Ideal para desenvolvedores que desejam entender como trabalhar com sistemas de agentes, criar integrações escaláveis e manter um código limpo e bem documentado.

Objetivo

Ser uma plataforma que ajude o empreendedor a atender e automatizar o processo de atendimento aos clientes.

Jornada

  • 1 - Login with Privy
  • 2 - Add founds in walley privy
  • 3 - Buy Nation pass
  • 4 - Buy NATO
  • 5 - Add CAP in agente
  • 6 - Add agent by template (atendente : clinica / empresa endenharia / ecommerce )
  • 7 - Channel [whatsapp / telegram] | Integration [calendar / ecommece ]

Especificação do Projeto nation.fun

Objetivo Principal

Fomentar a venda da NFT Nation Pass e do token $NATION, criando uma plataforma que permita o onboarding fácil de usuários para a criação e uso de agentes automatizados, facilitando o atendimento aos seus clientes de forma simples e eficiente.

Descrição

O projeto visa permitir que, em poucos passos, qualquer usuário possa criar seu próprio agente automatizado, capaz de atender clientes em diferentes nichos e canais, automatizando processos de atendimento para empreendedores e empresas.

Funcionalidades Principais

  1. Login com Privy: Autenticação segura e prática via Privy.
  2. Adicionar fundos na carteira Privy: Usuários adicionam fundos para operações dentro da plataforma.
  3. Comprar Nation Pass (NFT): Venda da NFT que dá acesso a funcionalidades exclusivas.
  4. Comprar token $NATION: Facilita transações e interações dentro do ecossistema.
  5. Adicionar CAP no agente: Personalização e configuração do agente automatizado.
  6. Adicionar agente por template: Criação rápida com modelos prontos para diferentes perfis:
    • Atendente para clínica
    • Empresa de engenharia
    • E-commerce
  7. Canais e integrações: Suporte para múltiplos canais e integrações, como:
    • Canais: WhatsApp, Telegram
    • Integrações: Calendário, E-commerce

Público-Alvo

Empreendedores e pequenos negócios que buscam automatizar e melhorar o atendimento ao cliente, utilizando agentes automatizados sem complexidade técnica.

Benefícios Esperados

  • Processo simplificado de onboarding para usuários.
  • Automatização eficiente de processos de atendimento.
  • Expansão do uso das NFTs e tokens no ecossistema Nation.
  • Plataforma escalável e integrável com vários canais e ferramentas externas.

✨ Características Principais

  • Conexão com Agentes: Conecte-se facilmente com agentes existentes
  • Criação de Novos Agentes: Interface intuitiva para criar e gerenciar agentes
  • Estrutura Limpa: Projeto bem organizado e fácil de estender
  • Testes Automatizados: Cobertura com testes unitários e BDD
  • Deploy Automático: Hospedagem via GitHub Pages
  • Documentação Completa: Código autoexplicativo com boas práticas

🛠️ Tecnologias Utilizadas

Tecnologia Uso
Gherkin BDD e especificações de comportamento
JavaScript Lógica e interatividade
Next.js Framework React para aplicações web
CSS Estilos e design responsivo
HTML Marcação semântica
Git Controle de versão
GitHub Pages Hospedagem estática

🚀 Como Começar

Pré-requisitos

  • Node.js 16+ instalado
  • npm ou yarn como gerenciador de pacotes
  • Git instalado na sua máquina

Instalação

  1. Clone o repositório: bash git clone https://github.com/govinda777/nation.fun.git cd nation.fun

  2. Instale as dependências: bash npm install # ou yarn install

  3. Execute o projeto em desenvolvimento: bash npm run dev # ou yarn dev

  4. Abra no navegador: http://localhost:3000

📁 Estrutura do Projeto

nation.fun/
├── public/              # Arquivos estáticos
├── components/          # Componentes React reutilizáveis
├── pages/              # Páginas da aplicação
├── styles/             # Arquivos de estilo CSS
├── features/           # Especificações BDD (.feature)
├── tests/              # Testes unitários
├── next.config.js      # Configuração Next.js
├── package.json        # Dependências do projeto
└── README.md           # Este arquivo

🧪 Testes

Execute os testes para garantir que tudo está funcionando corretamente:

# Testes unitários
npm run test

# BDD com Gherkin
npm run test:bdd

# Cobertura de testes
npm run test:coverage

🚢 Deploy

O projeto está configurado para deploy automático via GitHub Pages:

# Build para produção
npm run build

# Deploy
npm run deploy

Acesse seu projeto em: https://govinda777.github.io/nation.fun/

📖 Documentação

Para uma visão detalhada da arquitetura, guias de instalação, e referência da API, acesse nossa documentação completa aqui.

🤝 Contribuindo

Contribuições são bem-vindas! Para contribuir com o projeto:

  1. Faça um Fork do projeto
  2. Crie uma branch para sua feature (git checkout -b feature/MinhaFeature)
  3. Commit suas mudanças (git commit -am 'Adiciona MinhaFeature')
  4. Push para a branch (git push origin feature/MinhaFeature)
  5. Abra um Pull Request

Para mais detalhes, veja o CONTRIBUTING.md

📋 Código de Conduta

Este projeto adota um Código de Conduta que todos os contribuidores devem seguir. Leia o CODE_OF_CONDUCT.md para mais informações.

📄 Licença

Este projeto está licenciado sob a MIT License - veja o arquivo LICENSE para detalhes.

🎯 Roadmap

  • [ ] Autenticação de usuários
  • [ ] Dashboard avançado de agentes
  • [ ] Integração com mais plataformas
  • [ ] API REST completa
  • [ ] Documentação em vídeo

📞 Suporte

Tem dúvidas ou problemas?

👤 Autor

Govinda - @govinda777

🙏 Agradecimentos

Agradeço a todos que contribuem, reportam bugs e sugerem melhorias para este projeto!


Made with ❤️ by [govinda777](https://github.com/govinda777) [⬆ voltar ao topo](#nation.fun)