React와 Node.js를 사용하여 구축된 팀을 위한 빠르고 협업적인 지식 기반입니다.
www.getoutline.com에서 호스팅 버전을 사용하여 아웃라인을 사용해 보세요.
이는 아웃라인 및 모든 관련 서비스를 실행하는 소스 코드입니다. 아웃라인을 사용하고 싶다면 이 코드를 실행할 필요가 없습니다. getoutline.com에서 앱의 호스팅 버전을 제공합니다. 가이드에서 아웃라인 사용에 관한 문서를 찾을 수도 있습니다.
자신만의 아웃라인 사본을 실행하고 싶거나 개발에 기여하고 싶다면 이곳이 바로 여러분을 위한 곳입니다.
프로덕션 구성에서 자신만의 아웃라인 사본을 실행하려면 문서를 참조하세요.
문서에 대한 질문이나 개선 사항이 있는 경우 GitHub 토론에 스레드를 생성하세요.
개요의 변경, 수정, 개선에 기여하려는 경우 개발 환경 설정에 대한 간단한 가이드가 있습니다.
아웃라인은 소규모 팀에 의해 구축되고 유지관리됩니다. 버그를 수정하고 기능을 추가하는 데 여러분의 도움이 필요합니다!
끌어오기 요청을 제출하기 전에 GitHub에서 이슈를 생성하거나 댓글을 달아 핵심 팀과 논의 하세요 . 또한 토론에서 여러분의 의견을 듣고 싶습니다. 이렇게 하면 코드가 작성되기 전에 접근 방식이 합의되었는지 확인할 수 있습니다. 이렇게 하면 코드가 승인될 가능성이 훨씬 높아집니다.
시작할 수 있는 방법을 찾고 있다면 다음과 같은 방법으로 아웃라인을 개선하는 데 도움이 됩니다.
good first issue
라벨이 있는 이슈아웃라인 코드베이스에 대해 기여하거나 자세히 알아보고 싶다면 먼저 아키텍처 문서를 참조하여 애플리케이션 구성 방법에 대한 높은 수준의 개요를 확인하세요.
개발 중인 아웃라인에서는 카테고리 앞에 붙은 간단한 로깅을 콘솔에 출력합니다. 프로덕션에서는 JSON 로그를 출력하며, 이는 선호하는 로그 수집 파이프라인을 통해 쉽게 구문 분석될 수 있습니다.
HTTP 로깅은 기본적으로 비활성화되어 있지만 DEBUG=http
환경 변수를 설정하여 활성화할 수 있습니다.
우리는 애플리케이션의 중요한 부분에 대해 충분한 테스트 범위를 확보하는 것을 목표로 하며 100% 단위 테스트 범위를 목표로 하지 않습니다. 모든 API 엔드포인트 및 인증과 관련된 모든 항목을 철저히 테스트해야 합니다.
새로운 테스트를 추가하려면 Jest로 테스트를 작성하고 테스트된 코드 옆에 .test.js
확장자를 가진 파일을 추가하세요.
# To run all tests
make test
# To run backend tests in watch mode
make watch
make test
사용하여 테스트 데이터베이스가 생성되면 개별적으로 프런트엔드 및 백엔드 테스트를 직접 실행할 수 있습니다.
# To run backend tests
yarn test:server
# To run a specific backend test
yarn test:server myTestFile
# To run frontend tests
yarn test:app
Sequelize는 마이그레이션을 생성하고 실행하는 데 사용됩니다. 예를 들면 다음과 같습니다.
yarn sequelize migration:generate --name my-migration
yarn sequelize db:migrate
또는 테스트 데이터베이스에서 마이그레이션을 실행하려면 다음을 수행하세요.
yarn sequelize db:migrate --env test
개요는 BSL 1.1 라이선스를 받았습니다.