From 4da08d93fdc8d054664cb72e33780a00c2abeb8e Mon Sep 17 00:00:00 2001 From: voidSatisfaction Date: Sun, 8 Oct 2017 13:39:32 +0900 Subject: [PATCH 1/3] feat: add translated korean developement docs --- docs/ko/build.md | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/docs/ko/build.md b/docs/ko/build.md index 6bed0f0a..7bbe302f 100644 --- a/docs/ko/build.md +++ b/docs/ko/build.md @@ -1,43 +1,49 @@ # Build +## 환경 +* npm: 4.x +* node: 7.x + +`$ grunt pre-build`를 `npm v5.x`에서 실행할 수 없기 때문에, 반드시 `npm v4.x`를 사용하셔야 합니다. + ## 개발 -Webpack HRM을 개발을 위해 사용합니다. -다음 명령을 통해 저희가 해둔 설정을 사용 할 수 있습니다. +개발에 있어서 Webpack HRM을 사용합니다. +다음과 같은 명령을 프로젝트 디렉토리에서 실행하면, 기본 설정을 사용 할 수 있습니다. + +먼저, yarn을 이용해서 필요한 패키지들을 설치합니다. ``` -yarn run webpack +$ yarn ``` -몇 초 후, 다음 메세지를 보게 될겁니다. +그 다음, 아래의 명령으로 빌드를 끝내고 자동적으로 어플리케이션을 실행합니다. ``` -webpack: bundle is now VALID. +$ yarn run dev-start ``` -그럼 앱을 실행합시다. +이 명령은 `yarn run webpack` 과 `yarn run hot`을 동시에 실행합니다. 이는 두개의 터미널에서 각각의 명령을 동시에 실행하는 것과 같습니다. -``` -yarn run hot -``` +`Webpack`은 코드의 변화를 자동으로 탐지하여 적용시키는 역할을 합니다. -> 원래 앱은 `yarn start`로 실행가능합니다. 하지만 이 경우, 컴파일된 스크립트를 사용할 것입니다. +만약, `Failed to load resource: net::ERR_CONNECTION_REFUSED`과 같은 에러가 나타난다면 Boostnote를 리로드해주세요. -이로써 웹팩이 자동적으로 코드변경을 확인하고 적용해줄 것입니다. +![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) > ### 주의 > 가끔 직접 리프레쉬를 해주어야 하는 경우가 있습니다. -> 1. 콤포넌트의 컨스트럭터 함수를 수정할 경우샐 +> 1. 콤포넌트의 컨스트럭터 함수를 수정할 경우 > 2. 새로운 CSS코드를 추가할 경우(1.과 같은 이유: CSS클래스는 콤포넌트마다 다시 만들어 지는데, 이 작업은 컨스트럭터에서 일어납니다.) ## 배포 -그런트를 사용합니다. -실제 디플로이는 `grunt`로 실행할 수 있습니다. 하지만, 여기엔 Codesign과 Authenticode의 과정이 포함되어있기 때문에 사용 하셔선 안됩니다. +Boostnote에서는 배포 자동화를 위하여 그런트를 사용합니다. +실제 배포는 `grunt`로 실행할 수 있습니다. 하지만, 여기엔 Codesign과 Authenticode의 과정이 포함되어있기 때문에 사용 하셔선 안됩니다. 그래서, 실행파일만을 만드는 스크립트를 준비해 뒀습니다. -This build doesn't work on npm v5.3.0. So you need to use v5.2.0 when you build it. +이 빌드는 npm v5.3.0에서는 작동하지 않습니다. 그러므로, 성공적으로 빌드하기 위해서는 v5.2.0을 사용해야 합니다. ``` grunt pre-build From d5b37b241821b0c30bd04bdbe89918b38cb361e4 Mon Sep 17 00:00:00 2001 From: voidSatisfaction Date: Sun, 8 Oct 2017 13:58:15 +0900 Subject: [PATCH 2/3] feat: add debug docs for korean and link on debug.md --- docs/debug.md | 3 ++- docs/ko/debug.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/ko/debug.md diff --git a/docs/debug.md b/docs/debug.md index 297782dc..d4d23cd4 100644 --- a/docs/debug.md +++ b/docs/debug.md @@ -1,5 +1,6 @@ # How to debug Boostnote (Electron app) -This page is also available in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/debug.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/debug.md), and [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md) +This page is also available in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/debug.md), +[Korean](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/debug.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/debug.md), and [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md) Boostnote is an Electron app so it's based on Chromium; developers can use `Developer Tools` just like Google Chrome. diff --git a/docs/ko/debug.md b/docs/ko/debug.md new file mode 100644 index 00000000..290eee9c --- /dev/null +++ b/docs/ko/debug.md @@ -0,0 +1,21 @@ +# Boostnote의 디버그 방법(Electron app) + +Boostnote는 Electron 애플리케이션이므로 Chromium위에서 작동합니다. 그렇기 때문에 개발자분들은 Google Chrome 브라우저에서 처럼 `Developer Tools`를 사용하실 수 있습니다. + +다음과 같이 `Developer Tools`를 실행할 수 있습니다: +![how_to_toggle_devTools](https://cloud.githubusercontent.com/assets/11307908/24343585/162187e2-127c-11e7-9c01-23578db03ecf.png) + +`Developer Tools`는 다음과 같이 나타납니다: +![Developer_Tools](https://cloud.githubusercontent.com/assets/11307908/24343545/eff9f3a6-127b-11e7-94cf-cb67bfda634a.png) + +에러가 발생할 때에는, 에러메시지가 `console`위에 표시 됩니다. + +## 디버깅 +예를들면 `debugger`를 사용하여 코드 안에서 다음과 같이 일시 정지지점을 설정할 수 있습니다: + +![debugger](https://cloud.githubusercontent.com/assets/11307908/24343879/9459efea-127d-11e7-9943-f60bf7f66d4a.png) + +이는 단순한 하나의 예시에 불과합니다. 자기자신에게 가장 잘 맞는 디버그 방법을 찾는 것도 좋을 것 입니다. + +## 참고 +* [디버그에 관한 Google Chrome의 공식 문서](https://developer.chrome.com/devtools) From e64370e9a2688c425bbbc690d3a5f9abfa29894f Mon Sep 17 00:00:00 2001 From: voidSatisfaction Date: Sun, 8 Oct 2017 15:16:26 +0900 Subject: [PATCH 3/3] fix: no need enter --- docs/debug.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/debug.md b/docs/debug.md index d4d23cd4..6502cb51 100644 --- a/docs/debug.md +++ b/docs/debug.md @@ -1,6 +1,5 @@ # How to debug Boostnote (Electron app) -This page is also available in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/debug.md), -[Korean](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/debug.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/debug.md), and [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md) +This page is also available in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/debug.md), [Korean](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/debug.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/debug.md), and [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md) Boostnote is an Electron app so it's based on Chromium; developers can use `Developer Tools` just like Google Chrome.