Download octopus - download do código -fonte octopus

octopus

Outro código-fonte

1.0.0

Baixar

Polvo

O Octopus é uma página wiki interna sem servidor e fácil de configurar com suporte de diagramas de software interno. Ele usa o Markdown para escrever conteúdo e o aprimora com os diagramas GraphViz e FlowChart.js para facilitar a documentação do software.

Aqui está uma página de wiki padrão:

Tecnologia

O Octopus é um aplicativo Jamstack que usa o Google Firebase como back -end. Você não precisa de um servidor da Web (como o Apache) ou um banco de dados (como o MySQL) para colocá -lo em funcionamento. Você pode implantar o aplicativo em um CDN gratuitamente usando o netlify.

Com o polvo, você pode:

Exige que os usuários sejam conectados para ler ou editar o wiki (fornecedores suportados: Google, Github, email/senha, Twitter e telefone),
Crie regras de acesso para leitura e edição (restringem usuários específicos ou domínios de autenticação),
Host Wiki Page em um domínio personalizado.

Características

Crie novas páginas do Wiki com a linguagem de Markdown,
Menu Editar (usando o Markdown) para vincular facilmente as páginas do wiki,
Inclua os diagramas GraphViz e FlowChart.js dentro de seu conteúdo de marcação,
Veja quem está lendo seus artigos de wiki atualmente,
Ajuste seu front-end Wiki com o React (Create-React-App).

Exemplo de diagrama do sistema

Edição de página com Markdown

Instalação

Clone este repositório para o seu computador.
Copiar arquivo de modelo de configuração ( src/config/config.template.js ) para src/config/config.js .

cp src/config/config.template.js src/config/config.js

NOTA: Você pode comprometer com segurança o arquivo src/config/config.js em um repositório. Este arquivo não armazena credenciais confidenciais - todas as variáveis de configuração estarão disponíveis publicamente no arquivo .js de qualquer maneira.

Crie um novo projeto de Firebase aqui: https://firebase.google.com/
Escolha "Add FireBase ao seu aplicativo da web" e copie a configuração para src/config/config.js criada na etapa 2.

No console do Firebase, vá para o método de autenticação > Assinar , escolha um provedor e habilite-o. O Octopus foi testado com os provedores do Google e do GitHub.

Ainda na seção Autenticação > Método de assinatura , adicione o domínio que hospedará seu aplicativo à lista de domínios autorizados .

Construa o aplicativo:

npm install
npm run build

Implante o diretório build/ para o seu servidor da web.

Implantação sem servidor

Você pode pular hospedagem no aplicativo no seu servidor da web (Etapa 8 do Guia de Instalação acima). Tudo o que você precisa é implantar o aplicativo em um provedor de CDN baseado em nuvem.

Recomendamos usar o Netlify.

Ele implantará automaticamente o repo do Github do Octopus bifurcado na produção após cada compromisso. Ele também preparará um URL pronto para uso que todos os seus usuários podem acessar imediatamente. Mais tarde, você pode configurar um domínio personalizado para torná -lo mais profissional.

Nota: Ao implantar polvo via Netlify, preencha os seguintes detalhes no Assistente de Configuração:

Comando de construção: npm run build
Diretório de publicação: build

Segurança

Por padrão, qualquer usuário pode visualizar e editar sua página wiki. Provavelmente não é isso que você espera!

Para tornar seu conteúdo acessível apenas à sua empresa, acesse Firebase Console > Banco de dados > Regras e restrinja quem pode ler e editar sua página wiki.

Aqui está uma regra de exemplo se você usar o provedor de inscrição do Google e o endereço de e-mail da sua empresa termina com @livechatinc.com :

{
  "rules": {
    ".read": "auth.token.email.endsWith('@livechatinc.com')",
    ".write": "auth.token.email.endsWith('@livechatinc.com')"
  }
}

Você pode ler mais sobre possíveis regras de segurança na documentação das regras do banco de dados em tempo real.

Usando polvo

O polvo foi projetado para ser muito fácil de usar.

Para criar uma nova página, basta inserir o URL que você deseja criar, por exemplo: https://<your-octopus-domain>/test/new-page . Se essa página ainda não foi criada, você verá a seguinte tela:

Ao clicar em "Criar esta página", a nova página será criada e preenchida com conteúdo padrão, pronto para editar:

Depois que a página estiver pronta, você pode incluí -lo facilmente no menu:

É isso. Envie todos os seus companheiros de equipe link para o Octopus e eles estão prontos para contribuir!

Antecedentes do projeto

Por que construímos polvo?

Lutamos para encontrar um software fácil de usar para documentar sistemas internos no LiveChat.

Queríamos que fosse fácil contribuir para pessoas não técnicas e incluir diagramas de software facilmente editáveis . Não conseguimos encontrar um produto satisfatório, então construímos um.