outline

Uma base de conhecimento rápida e colaborativa para sua equipe construída usando React e Node.js.
Experimente o Outline usando nossa versão hospedada em www.getoutline.com.

Este é o código-fonte que executa o Outline e todos os serviços associados. Se quiser usar o Outline, não será necessário executar este código, oferecemos uma versão hospedada do aplicativo em getoutline.com. Você também pode encontrar documentação sobre como usar o Outline em nosso guia.

Se você deseja executar sua própria cópia do Outline ou contribuir com o desenvolvimento, este é o lugar para você.

Instalação

Consulte a documentação para executar sua própria cópia do Outline em uma configuração de produção.

Se você tiver dúvidas ou melhorias nos documentos, crie um tópico nas discussões do GitHub.

Desenvolvimento

Há um breve guia para configurar um ambiente de desenvolvimento se você desejar contribuir com alterações, correções e melhorias no Outline.

Contribuindo

O Outline é criado e mantido por uma pequena equipe – adoraríamos sua ajuda para corrigir bugs e adicionar recursos!

Antes de enviar uma solicitação pull , discuta com a equipe principal criando ou comentando um problema no GitHub – também adoraríamos ouvir sua opinião nas discussões. Dessa forma, podemos garantir que uma abordagem seja acordada antes que o código seja escrito. Isso resultará em uma probabilidade muito maior de seu código ser aceito.

Se você está procurando maneiras de começar, aqui está uma lista de maneiras de nos ajudar a melhorar o Outline:

• Tradução para outros idiomas
• Problemas com good first issue
• Melhorias de desempenho, tanto no servidor quanto no frontend
• Felicidade e documentação do desenvolvedor
• Bugs e outros problemas listados no GitHub

Arquitetura

Se você estiver interessado em contribuir ou aprender mais sobre a base de código do Outline, consulte primeiro o documento de arquitetura para obter uma visão geral de alto nível de como o aplicativo é montado.

Depuração

No desenvolvimento, o Outline gera um registro simples no console, prefixado por categorias. Na produção, ele gera logs JSON, que podem ser facilmente analisados ​​pelo pipeline de ingestão de logs de sua preferência.

O log HTTP está desabilitado por padrão, mas pode ser habilitado configurando a variável de ambiente DEBUG=http .

Testes

Nosso objetivo é ter cobertura de testes suficiente para partes críticas do aplicativo e não pretendemos ter 100% de cobertura de testes unitários. Todos os endpoints da API e qualquer coisa relacionada à autenticação devem ser exaustivamente testados.

Para adicionar novos testes, escreva seus testes com Jest e adicione um arquivo com extensão .test.js próximo ao código testado.

 # To run all tests
make test

# To run backend tests in watch mode
make watch

Depois que o banco de dados de teste for criado com make test você poderá executar individualmente testes de front-end e back-end diretamente.

 # To run backend tests
yarn test:server

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

# To run frontend tests
yarn test:app

Migrações

Sequelize é usado para criar e executar migrações, por exemplo:

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

Ou para executar migrações no banco de dados de teste:

yarn sequelize db:migrate --env test

Atividade

Licença

O Outline é licenciado pela BSL 1.1.