Descarga octopus - Descarga del código fuente octopus

octopus

Otro código fuente

1.0.0

Descargar

Pulpo

Octopus es una página de wiki interna sin servidor y fácil de establecer con soporte de diagramas de software incorporados. Utiliza Markdown para escribir contenido y lo mejora con GraphViz y FlowChart.js Diagramas para una fácil documentación de software.

Aquí hay una página wiki predeterminada:

Tecnología

Octopus es una aplicación Jamstack que usa Google Firebase como su backend. No necesita un servidor web (como Apache) o una base de datos (como MySQL) para que lo esté en funcionamiento. Puede implementar la aplicación en un CDN de forma gratuita usando NetLify.

Con pulpo, puedes:

requiere que los usuarios se inicien sesión para leer o editar el wiki (proveedores compatibles: Google, Github, correo electrónico/contraseña, Twitter y teléfono),
Cree reglas de acceso para leer y editar (restringir usuarios particulares o dominios de autores),
Página de Wiki de host en un dominio personalizado.

Características

Crea nuevas páginas wiki con lenguaje markdown,
Editar menú (usando Markdown) para vincular fácilmente a las páginas wiki,
Incluya diagramas GraphViz y FlowChart.js dentro de su contenido de Markdown,
Vea quién está leyendo actualmente sus artículos wiki,
Ajuste su wiki front-end con React (Crear react-app).

Diagrama del sistema de ejemplo

Edición de página con Markdown

Instalación

Clone este repositorio a su computadora.
Copiar el archivo de plantilla de configuración ( src/config/config.template.js ) a src/config/config.js .

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

Nota: puede confirmar el archivo src/config/config.js de manera segura en un repositorio. Este archivo no almacena credenciales confidenciales: todas las variables de configuración estarán disponibles públicamente en el archivo .js de todos modos.

Cree un nuevo proyecto de Firebase aquí: https://firebase.google.com/
Elija "Agregue Firebase a su aplicación web" y copie la configuración en src/config/config.js creada en el paso 2.

En la consola Firebase, vaya a la autenticación > Método de inicio de sesión , elija un proveedor y habilitelo. Octopus ha sido probado con los proveedores de Google y GitHub.

Aún en la sección de método de inicio de sesión de autenticación >, agregue el dominio que aloje su aplicación a la lista de dominios autorizados .

Cree la aplicación:

npm install
npm run build

Implemente la build/ directorio a su servidor web.

Implementación sin servidor

Puede omitir alojamiento de la aplicación en su servidor web (paso 8 desde la guía de instalación anterior). Todo lo que necesita es implementar la aplicación en un proveedor de CDN basado en la nube.

Recomendamos usar Netlify.

Implementará automáticamente su repositorio de Octopus Github en la producción después de cada confirmación. También preparará una URL lista para usar a la que todos sus usuarios pueden acceder de inmediato. Más adelante, puede configurar un dominio personalizado para que parezca más profesional.

Nota: Al implementar Octopus a través de Netlify, complete los siguientes detalles en el Asistente de configuración:

Comando de compilación: npm run build
Publicar directorio: build

Seguridad

De manera predeterminada, cualquier usuario puede ver y editar su página Wiki. ¡Probablemente esto no es lo que esperas!

Para que su contenido sea accesible solo para su empresa, vaya a Firebase Console > Base de datos > Reglas y restringir quién puede leer y editar su página Wiki.

Aquí hay una regla de ejemplo si usa el proveedor de inicio de sesión de Google y la dirección de correo electrónico de su empresa termina con @livechatinc.com :

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

Puede leer más sobre posibles reglas de seguridad en la documentación de las reglas de la base de datos en tiempo real.

Usando pulpo

Octopus está diseñado para ser muy fácil de usar.

Para crear una nueva página, solo ingrese la URL que desea crear, por ejemplo: https://<your-octopus-domain>/test/new-page . Si dicha página aún no se ha creado, verá la siguiente pantalla:

Cuando haga clic en "Crear esta página", se creará y llenará una nueva página con contenido predeterminado, listo para editar:

Una vez que la página esté lista, puede incluirla fácilmente en el menú:

Eso es todo. ¡Envíe a todos sus compañeros de equipo enlace a Octopus y están listos para contribuir!

Antecedentes de proyectos

¿Por qué construimos pulpo?

Hemos tenido problemas para encontrar un software fácil de usar para documentar sistemas internos en Livechat.

Queríamos que fuera fácil de contribuir para personas no técnicas e incluya diagramas de software fácilmente editables . No pudimos encontrar un producto satisfactorio, por lo que hemos construido uno.