diff --git a/docs/build.md b/docs/build.md index 8dced1be..08fd9ac5 100644 --- a/docs/build.md +++ b/docs/build.md @@ -1,5 +1,5 @@ # Build -This page is also available in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Korean](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), and [French](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md). +This page is also available in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Korean](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [French](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md) and [German](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md). ## Environments * npm: 4.x diff --git a/docs/de/build.md b/docs/de/build.md new file mode 100644 index 00000000..44b744ca --- /dev/null +++ b/docs/de/build.md @@ -0,0 +1,87 @@ +# Build +Diese Seite ist auch verfügbar in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Korean](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [French](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md) and [German](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md). + +## Umgebungen +* npm: 4.x +* node: 7.x + +Du solltest `npm v4.x` benutzen weil `$ grunt pre-build` scheitert mit Version `v5.x`. + +## Entwicklung + +Wir verwenden Webpack HMR für die Entwicklung von Boostnote. +Durch Ausführen der folgenden Befehle, im root Verzeichnis des Projektes, wird Boostnote mit der Default Konfiguration gestartet. + +Installiere die nötigen Pakete unter Verwendung von yarn. + +``` +$ yarn +``` + +Bauen und Ausführen. + +``` +$ yarn run dev-start +``` + +Dieser Befehl startet `yarn run webpack` und `yarn run hot` parallel. Es hat den selben Effekt wie beide Befehle separat in zwei Terminals zu starten. + +Das `webpack` überprüft den Code auf Änderungen und wendet diese dann automatisch an. + +Wenn folgender Fehler passiert: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, bitte Boostnote neu starten. + +![net::ERR_CONNECTION_REFUSED](https://cloud.githubusercontent.com/assets/11307908/24343004/081e66ae-1279-11e7-8d9e-7f478043d835.png) + +> ### Notiz +> Es gibt einige Fälle bei denen die App manuell zu refreshen ist. +> 1. Wenn eine "constructor method" einer Komponente manuell editiert wird. +> 2. Wenn eine neue CSS Klasse ergänzt wird (ähnlich wie 1: die CSS Klasse wird von jeder Komponenete neu geschrieben. Dieser Prozess passiert in der "Constructor method".) + +## Deploy + +Wir verwenden Grunt um das Deployment zu automatisieren. +Du kannst das Programm unter Verwendung von `grunt` bauen. Jedoch empfehlen wir das nicht denn der default task beinhaltet codesign und authenticode. + +Deshalb haben wir ein separates Script vorbereitet welches eine ausführbare Datei erstellt. + +Dieser build funktioniert nicht mit npm v5.3.0. Deshalb musst du für den Build die Version v5.2.0 verwenden. + +``` +grunt pre-build +``` +Du findest die ausführbare Datein in dem Verzeichnis `dist`. Beachte, der auto updater funktioniert nicht da die app nicht signiert ist. + +Wenn du es für notwendig erachtest, kannst du codesign or authenticode mit dieser ausführbaren Datei verwenden. + +## Erstelle eigene Distributions Pakete (deb, rpm) + +Distributions Pakete können mittels `grunt build` auf Linux Plattformen (e.g. Ubuntu, Fedora) erstellt werden. + +> Beachte: Du kannst bei `.deb` and `.rpm` in der selben Umgebung erstellen. + +Nach der Installation der supporteten Version von `node` and `npm`, installiere auch build dependency packages. + + +Ubuntu/Debian: + +``` +$ sudo apt-get install -y rpm fakeroot +``` + +Fedora: + +``` +$ sudo dnf install -y dpkg dpkg-dev rpm-build fakeroot +``` + +Dann führe `grunt build` aus. + +``` +$ grunt build +``` + +Du findest nun die `.deb` undd `.rpm` Pakete in dem `dist` Ordner. + +--- + +Special thanks: Translated by [gino909](https://github.com/gino909) diff --git a/docs/de/debug.md b/docs/de/debug.md new file mode 100644 index 00000000..ee1a734c --- /dev/null +++ b/docs/de/debug.md @@ -0,0 +1,25 @@ +# How to debug Boostnote (Electron app) +Diese Seite ist auch verfügbar 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), [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md), [French](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/debug.md) and [German](https://github.com/BoostIO/Boostnote/blob/add-german-documents/docs/de/debug.md). + +Boostnote is eine Electron app, somit basiert sie auf Chromium; Entwickler können die `Developer Tools` verwenden, wie Google Chrome. + +Du kannst die `Developer Tools` so einschalten: +![how_to_toggle_devTools](https://cloud.githubusercontent.com/assets/11307908/24343585/162187e2-127c-11e7-9c01-23578db03ecf.png) + +Die `Developer Tools` schauen dann ungefähr so aus: +![Developer_Tools](https://cloud.githubusercontent.com/assets/11307908/24343545/eff9f3a6-127b-11e7-94cf-cb67bfda634a.png) + +Wenn Fehler vorkommen, werden die Fehlermeldungen in der `console` ausgegeben. + +## Debugging +Zum Beispiel kannst du mit dem `debugger` Haltepunkte im Code setzen wie hier veranschaulicht: +![debugger](https://cloud.githubusercontent.com/assets/11307908/24343879/9459efea-127d-11e7-9943-f60bf7f66d4a.png) + +Das ist ledigtlich ein Beispiel, du kannst die Art von Debugging verwenden die für dich am besten ist. + +## Referenz +* [Official document of Google Chrome about debugging](https://developer.chrome.com/devtools) + +--- + +Special thanks: Translated by [gino909](https://github.com/gino909) diff --git a/docs/debug.md b/docs/debug.md index f45af58f..30c217a4 100644 --- a/docs/debug.md +++ b/docs/debug.md @@ -1,5 +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), [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md), and [French](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/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), [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md), [French](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/debug.md) and [German](https://github.com/BoostIO/Boostnote/blob/add-german-documents/docs/de/debug.md). Boostnote is an Electron app so it's based on Chromium; developers can use `Developer Tools` just like Google Chrome.