diff --git a/docs/ru/build.md b/docs/ru/build.md new file mode 100644 index 00000000..4f3f6340 --- /dev/null +++ b/docs/ru/build.md @@ -0,0 +1,52 @@ +# Сборка + +## Используемые инструменты +* npm: 4.x +* node: 7.x + +Вы должны использовать `npm v4.x`, так как `$ grand pre-build` не работает в `v5.x`. + +## Разработка + +Мы используем Webpack HMR при разработке Boostnote. +Выполнение следующих команд в корне проекта запустит Boostnote с настройками по умолчанию. + +Установите необходимые пакеты с помощью yarn. + +``` +$ yarn +``` + +Соберите и запустите. + +``` +$ yarn run dev-start +``` + +Эта команда выполняет `yarn run webpack` и `yarn run hot` параллельно. Результат будет такой же, если вы выполните эти две команды раздельно. + +`Webpack` будет следить за изменениями в коде и будет применять их автоматически. + +Если возникает следующая ошибка: `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. При редактировании метода конструктора компонента +> 2. При добавлении нового класса CSS (аналогично 1: Класс CSS перезаписывается каждым компонентом. Этот процесс выполняется в методе Constructor.) + +## Деплой + +Мы используем Grunt для автоматического деплоя. +Вы можете создать задачу, используя `grunt`. Однако мы не рекомендуем этого делать, так как задача по умолчанию включает в себя код и аутентификацию. + +Мы подготовили отдельный скрипт, который просто создает исполняемый файл: + +``` +grunt pre-build +``` + +Вы найдете исполняемый файл в папке `dist`. Обратите внимание: автоматическое обновление не будет работать, потому что приложение не подписано. + +Если вам необходимо, вы можете использовать код или аутентификацию с помощью этого исполняемого файла. diff --git a/docs/ru/debug.md b/docs/ru/debug.md new file mode 100644 index 00000000..a6a3f92a --- /dev/null +++ b/docs/ru/debug.md @@ -0,0 +1,20 @@ +# Как отладить Boostnote (приложение Electron) +Boostnote - это программа, сделанная с помощью Electron, поэтому она базируется на Chromium. Разработчики могут использовать `Developer Tools` в Google Chrome для отладки. + +Вы можете переключиться в `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) diff --git a/docs/ru/testing.md b/docs/ru/testing.md new file mode 100644 index 00000000..ffe3b9d5 --- /dev/null +++ b/docs/ru/testing.md @@ -0,0 +1,15 @@ +# Тестирование для Boostnote +## Тестирование e2e +Существуют тесты e2e для Boostnote, написанные на [ava](https://github.com/avajs/ava) и [spectron](https://github.com/electron/spectron). + +### Как запустить +Для тестирование e2e существует команда: + +``` +$ yarn run test:e2e +``` + +Причина, по которой я использую другую команду тестирования - это удобство travisCI. + +### TravisCI +Я установил тесты e2e, запущенные на travisCI, только в ветке master. Если вас это интересует, ознакомьтесь с файлом .travis.yml