outline

Una base de conocimientos rápida y colaborativa para su equipo creada con React y Node.js.
Pruebe Outline utilizando nuestra versión alojada en www.getoutline.com.

Este es el código fuente que ejecuta Outline y todos los servicios asociados. Si desea utilizar Outline, no necesita ejecutar este código; ofrecemos una versión alojada de la aplicación en getoutline.com. También puede encontrar documentación sobre el uso de Outline en nuestra guía.

Si desea ejecutar su propia copia de Outline o contribuir al desarrollo, este es el lugar para usted.

Instalación

Consulte la documentación para ejecutar su propia copia de Outline en una configuración de producción.

Si tiene preguntas o mejoras para los documentos, cree un hilo en las discusiones de GitHub.

Desarrollo

Hay una breve guía para configurar un entorno de desarrollo si desea contribuir con cambios, correcciones y mejoras a Outline.

Contribuyendo

Un pequeño equipo crea y mantiene Outline. ¡Nos encantaría contar con tu ayuda para corregir errores y agregar funciones!

Antes de enviar una solicitud de extracción, hable con el equipo central creando o comentando un problema en GitHub; también nos encantaría saber de usted en las discusiones. De esta manera podemos asegurarnos de que se acuerde un enfoque antes de escribir el código. Esto dará como resultado una probabilidad mucho mayor de que se acepte su código.

Si está buscando formas de comenzar, aquí tiene una lista de formas de ayudarnos a mejorar Outline:

• Traducción a otros idiomas
• Problemas con good first issue
• Mejoras de rendimiento, tanto en el servidor como en el frontend.
• Felicidad del desarrollador y documentación.
• Errores y otros problemas enumerados en GitHub

Arquitectura

Si está interesado en contribuir o aprender más sobre el código base de Outline, consulte primero el documento de arquitectura para obtener una descripción general de alto nivel de cómo se construye la aplicación.

Depuración

En desarrollo, Outline genera un registro simple en la consola, con el prefijo de categorías. En producción, genera registros JSON, que pueden analizarse fácilmente mediante su canal de ingesta de registros preferido.

El registro HTTP está deshabilitado de forma predeterminada, pero se puede habilitar configurando la variable de entorno DEBUG=http .

Pruebas

Nuestro objetivo es tener una cobertura de prueba suficiente para las partes críticas de la aplicación y no aspiramos a una cobertura de prueba unitaria del 100 %. Todos los puntos finales de API y todo lo relacionado con la autenticación deben probarse exhaustivamente.

Para agregar nuevas pruebas, escriba sus pruebas con Jest y agregue un archivo con la extensión .test.js al lado del código probado.

 # To run all tests
make test

# To run backend tests in watch mode
make watch

Una vez que se crea la base de datos de prueba con make test puede ejecutar pruebas de frontend y backend de forma individual directamente.

 # To run backend tests
yarn test:server

# To run a specific backend test
yarn test:server myTestFile

# To run frontend tests
yarn test:app

Migraciones

Sequelize se utiliza para crear y ejecutar migraciones, por ejemplo:

yarn sequelize migration:generate --name my-migration
yarn sequelize db:migrate

O para ejecutar migraciones en la base de datos de prueba:

yarn sequelize db:migrate --env test

Actividad

Licencia

Outline tiene licencia BSL 1.1.