Smart Mermaid: ferramenta de IA para gerar rapidamente fluxogramas e diagramas de tempo com texto

O Smart Mermaid é um aplicativo da Web de código aberto orientado por IA que se concentra na conversão de texto em linguagem natural inserido pelos usuários em código formatado pelo Mermaid e na geração de gráficos visuais. Ele simplifica o processo de criação de gráficos por meio da tecnologia de IA, eliminando a necessidade de escrever manualmente códigos complexos. Os usuários só precisam usar um texto simples para descrever o processo ou a lógica de negócios. O Smart Mermaid pode analisar e gerar de forma inteligente fluxogramas, diagramas de tempo, diagramas de classe e outros diagramas diversos. O projeto é compatível com a implantação de um clique no Docker e é adequado para desenvolvedores, gerentes de produtos e pessoas que precisam gerar rapidamente diagramas profissionais. O código está hospedado no GitHub, com 810 estrelas e 92 ramificações, mostrando o suporte ativo da comunidade.

Lista de funções

• Gráficos gerados por linguagem naturalDescrição: O usuário insere uma descrição de texto e o AI analisa e gera automaticamente o código do gráfico no formato Mermaid.
• Suporte a vários tipos de gráficosInclui fluxogramas, diagramas de tempo, diagramas de classe, gráficos de Gantt e diagramas de arquitetura, abrangendo cenários comerciais comuns.
• Configuração personalizada de IASuporte para configuração de serviços de IA, como endereços e chaves de API, para atender a requisitos individuais.
• Editor de gráficos profissionalFunções de edição e visualização e suporte a vários modos de renderização para aprimorar o profissionalismo dos gráficos.
• Implantação do Docker em um cliqueCrie rapidamente ambientes locais ou de servidor com o Docker para facilitar o uso.
• controle de acessoSuporte para configuração de senhas de acesso para proteger o conteúdo gerado pelo usuário.

Usando a Ajuda

Processo de instalação

O Smart Mermaid oferece suporte à implementação rápida via Docker. Veja a seguir as etapas detalhadas de instalação:

1. Repositório de código clone
   Execute o seguinte comando no terminal para clonar o projeto localmente:

   git clone https://github.com/liujuntao123/smart-mermaid.git
   cd smart-mermaid
   

2. Mudança para uma ramificação do Docker
   Observação: A ramificação principal não contém o arquivo de configuração do Docker e você precisa mudar para a ramificação docker Ramificação:

   git checkout docker
   

3. Configuração dos serviços de IA
   O Smart Mermaid depende de serviços externos de IA, como a API OpenAI, para analisar o texto. As seguintes variáveis de ambiente precisam ser configuradas:
   • compilador docker-compose.yml ou arquivo de variável de ambiente, adicione o seguinte:

     AI_API_URL=https://api.openai.com/v1
     AI_API_KEY=你的API密钥
     AI_MODEL_NAME=gpt-3.5-turbo
     

   • Se o controle de acesso for necessário, defina-o:

     ACCESS_PASSWORD=你的访问密码
     

4. Início dos serviços
   Inicie o serviço usando o Docker Compose:

   docker-compose up -d
   

   Quando o serviço for iniciado, o Smart Mermaid será executado localmente http://localhost:3000.

5. Acesso a aplicativos
   Abra seu navegador e acesse http://localhost:3000. Se houver uma senha de acesso definida, digite a senha para acessar a tela de operação.

Funções principais

1. geração de gráficos

• procedimento::
  1. Na caixa de entrada de texto da página inicial, digite o texto em linguagem natural que descreve o processo comercial. Por exemplo, "O usuário faz login no sistema, o sistema verifica sua identidade e, em caso de sucesso, ele vai para a página inicial; em caso de falha, ele recebe um aviso de erro".
  2. Clique no botão Generate (Gerar) e a IA analisará o texto e gerará o código da sereia correspondente.
  3. O sistema seleciona automaticamente o tipo de diagrama apropriado (por exemplo, fluxograma ou diagrama de tempo) ou você pode especificar o tipo manualmente.
  4. Os gráficos gerados são exibidos na área de visualização à direita e permitem ajustes em tempo real.
• advertência::
  • Digite o texto da forma mais clara possível, descrevendo relações lógicas e evitando declarações vagas.
  • Suporta até 20.000 caracteres de entrada, com um limite de 5 vezes de geração por dia (configurável por meio de um perfil) NEXT_PUBLIC_DAILY_USAGE_LIMIT (Modificado).

2. edição e exportação

• Editar gráfico::
  • Você pode modificar o código do Mermaid diretamente clicando no botão "Edit" (Editar) na área de visualização.
  • Após o ajuste do código, os gráficos são atualizados em tempo real para uma rápida depuração.
• Exportar gráficos::
  • Suporte para exportação de gráficos para arquivos SVG, PNG ou código Mermaid.
  • Clique no botão "Export" (Exportar), selecione o formato e faça o download localmente.
• modo de renderização::
  • Oferece suporte a vários modos de renderização (por exemplo, temas escuros ou claros), que podem ser alternados nas configurações.

3. configuração personalizada

• Configuração do serviço de IA::
  • existir docker-compose.yml modificação AI_API_URL responder cantando AI_API_KEYO sistema de inteligência artificial (IA), suporta o acesso a outros serviços de IA (por exemplo, modelos implantados localmente).
  • ajustável AI_MODEL_NAME Use modelos diferentes para otimizar a geração.
• restrição de acesso::
  • configurar ACCESS_PASSWORD Depois disso, somente os usuários que digitarem a senha correta poderão acessar o aplicativo, adequado para uso interno da equipe.

4. histórico de visualização

• Os gráficos gerados são salvos na sessão local, e você pode visualizar os gráficos gerados anteriormente clicando em "History" (Histórico).
• Suporta a reedição ou a exclusão de gráficos históricos para facilitar o gerenciamento.

Perguntas frequentes

• Falha na análise de IA: Inspeção AI_API_KEY se ele é válido e certifique-se de que a conexão de rede esteja funcionando.
• Erro de inicialização do DockerConfirma que você mudou para docker Filial, verifique docker-compose.yml A configuração está correta.
• Anomalia na exibição do gráficoVerifique se o código do Mermaid está sintaticamente correto, consultando a documentação oficial do Mermaid (https://mermaid.js.org).

cenário do aplicativo

1. Os gerentes de produto projetam processos de negócios
   Os gerentes de produto precisam produzir rapidamente fluxogramas ou diagramas de tempo para descrever a lógica comercial. O Smart Mermaid permite que eles insiram requisitos em linguagem natural e gerem rapidamente diagramas profissionais que economizam tempo.
2. Documentação do desenvolvedor
   Ao escrever documentação técnica, os desenvolvedores podem usar o Smart Mermaid para gerar rapidamente diagramas de arquitetura ou diagramas de classe que podem ser incorporados em arquivos Markdown para melhorar a legibilidade.
3. Trabalho em equipe e apresentação
   Ao discutir um projeto, as equipes podem usar o Smart Mermaid para gerar e exportar tabelas e gráficos para uso em PPTs ou apresentações on-line, facilitando a comunicação.
4. Educação e treinamento
   Professores ou instrutores podem usar o Smart Mermaid para transformar relações lógicas complexas em diagramas visuais que ajudam os alunos a entender.

QA

1. Quais tipos de gráficos são compatíveis com o Smart Mermaid?
   Oferece suporte a fluxogramas, diagramas de tempo, diagramas de classe, gráficos de Gantt e diagramas de arquitetura, abrangendo a maioria dos cenários comerciais.
2. Como posso garantir que os gráficos gerados pela IA sejam precisos?
   Insira descrições de texto claras para esclarecer as relações lógicas. Depois de gerado, você pode editar manualmente o código Mermaid para garantir que o gráfico atenda às suas necessidades.
3. É necessário ter experiência em programação?
   Não é necessário.O Smart Mermaid gera gráficos por meio de linguagem natural e é adequado para não programadores. Os desenvolvedores podem editar ainda mais o código para otimizá-lo.
4. Quais pré-requisitos são necessários para a implantação do Docker?
   O Git e o Docker Compose precisam ser instalados para garantir o acesso à rede aos serviços de IA (por exemplo, API do OpenAI).