diff --git a/docs/build.md b/docs/build.md index f2b3e5ac..eaf94666 100644 --- a/docs/build.md +++ b/docs/build.md @@ -1,10 +1,11 @@ # 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), [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). + +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), [Portuguese](https://github.com/BoostIO/Boostnote/blob/master/docs/pt_BR/build.md) and [German](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md). ## Environments -* npm: 6.x -* node: 8.x +- npm: 6.x +- node: 8.x ## Development @@ -24,7 +25,9 @@ $ yarn run dev ``` > ### Notice +> > There are some cases where you have to refresh the app manually. +> > 1. When editing a constructor method of a component > 2. When adding a new css class (similar to 1: the CSS class is re-written by each component. This process occurs at the Constructor method.) @@ -51,7 +54,6 @@ Distribution packages are created by exec `grunt build` on Linux platform (e.g. After installing the supported version of `node` and `npm`, install build dependency packages. - Ubuntu/Debian: ``` diff --git a/docs/de/build.md b/docs/de/build.md index a3d8e274..65f2b8c3 100644 --- a/docs/de/build.md +++ b/docs/de/build.md @@ -1,10 +1,11 @@ # Build -Diese Seite ist auch verfügbar in [Japanisch](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Koreanisch](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russisch](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Vereinfachtem Chinesisch](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [Französisch](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md) und [Deutsch](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md). + +Diese Seite ist auch verfügbar in [Japanisch](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Koreanisch](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russisch](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Vereinfachtem Chinesisch](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [Französisch](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md), [Portugiesisch](https://github.com/BoostIO/Boostnote/blob/master/docs/pt_BR/build.md) und [Deutsch](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md). ## Umgebungen -* npm: 6.x -* node: 8.x +- npm: 6.x +- node: 8.x ## Entwicklung @@ -24,7 +25,9 @@ $ yarn run dev ``` > ### 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".) @@ -51,7 +54,6 @@ Distributions Pakete können mittels `grunt build` auf Linux Plattformen (e.g. U Nach der Installation der supporteten Version von `node` and `npm`, installiere auch build dependency packages. - Ubuntu/Debian: ``` diff --git a/docs/fr/build.md b/docs/fr/build.md index e66a11aa..7628a3e1 100644 --- a/docs/fr/build.md +++ b/docs/fr/build.md @@ -1,10 +1,11 @@ # Build -Cette page est également disponible en [Anglais](https://github.com/BoostIO/Boostnote/blob/master/docs/build.md), [Japonais](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Coréen](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russe](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Chinois Simplifié](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md) et en [Allemand](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md) + +Cette page est également disponible en [Anglais](https://github.com/BoostIO/Boostnote/blob/master/docs/build.md), [Japonais](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Coréen](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russe](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Chinois Simplifié](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [Portugais](https://github.com/BoostIO/Boostnote/blob/master/docs/pt_BR/build.md) et en [Allemand](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md) ## Environnements -* npm: 6.x -* node: 8.x +- npm: 6.x +- node: 8.x ## Développement @@ -16,6 +17,7 @@ Installez les paquets requis à l'aide de `yarn`. ``` $ yarn ``` + Build et start ``` @@ -23,7 +25,9 @@ $ yarn run dev ``` > ### Notice +> > Il y a certains cas où vous voudrez relancer l'application manuellement. +> > 1. Quand vous éditez la méthode constructeur dans un composant > 2. Quand vous ajoutez une nouvelle classe css. (Comme pour 1: la classe est réécrite pour chaque composant. Le process intervient dans la méthode constructeur) @@ -37,6 +41,7 @@ Nous avons donc préparé un script séparé qui va rendre un fichier exécutabl ``` grunt pre-build ``` + Vous trouverez l'exécutable dans le dossier `dist`. Note : l'auto updater ne marchera pas car l'application n'est pas signée. @@ -50,7 +55,6 @@ Les paquets sont créés en exécutant `grunt build` sur une plateforme Linux (e Après avoir installé la version supportée de `node` et de `npm`, installer les paquets de builds. - Ubuntu/Debian: ``` diff --git a/docs/pt_BR/build.md b/docs/pt_BR/build.md new file mode 100644 index 00000000..07f0ce67 --- /dev/null +++ b/docs/pt_BR/build.md @@ -0,0 +1,75 @@ +# Build + +Esta página também está disponível em [Japônes](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [Coreano](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [Russo](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [Chinês simplificado](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [Francês](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md) e [Alemão](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md). + +## Ambiente + +- npm: 6.x +- node: 8.x + +## Desenvolvimento + +Nós usamos o Webpack HMR para desenvolver o Boostnote. +Executando os seguintes comandos, no diretório raiz do projeto, irá iniciar o Boostnote com as configurações padrão. + +Instala os pacotes necessários usando o yarn. + +``` +$ yarn +``` + +Gerar e iniciar. + +``` +$ yarn run dev +``` + +> ### Notice +> +> Existe alguns casos onde você precisa atualizar o app manualmente. +> +> 1. Quando editar um método construtor de um componente +> 2. Quando adicionar uma nova classe de css (similiar ao 1: a classe do css é reescrita por cada componente. Esse processo ocorre através do método construtor) + +## Deploy + +Nós usamos o Grunt para automatizar o desenvolvimento. +Você pode gerar o programa usando `grunt`. Contudo, nós não recomendamos isso porque a tarefa padrão inclui _codedesign_ e _authenticode_. + +Então nós preparamos um _script_ separado, o qual somente cria um executável. + +``` +grunt pre-build +``` + +Você irá encontrar o executável na pasta `dist`. Nota: o atualizador automático não funciona por que o app não está certificado. + +Se você achar isto necessário, você pode usar o _codesign_ ou o _authenticode_ com esse executável. + +## Faça seus próprios pacotes de distribuição (deb, rpm) + +Pacotes de distribuição são gerados através do comando `grunt build` em plataforma Linux (e.g. Ubuntu, Fedora). + +> Nota: você pode criar `.deb` e `.rpm` em um mesmo ambiente. + +Depois de instalar uma versão suportada do `node` e do `npm`, deve-se instalar as dependências para gerar os pacotes. + +Ubuntu/Debian: + +``` +$ sudo apt-get install -y rpm fakeroot +``` + +Fedora: + +``` +$ sudo dnf install -y dpkg dpkg-dev rpm-build fakeroot +``` + +Então execute `grunt build`. + +``` +$ grunt build +``` + +Você vai encontrar o `.deb` e o `.rpm` na pasta`dist`. diff --git a/docs/zh_TW/build.md b/docs/zh_TW/build.md index 65b086ac..151f946d 100644 --- a/docs/zh_TW/build.md +++ b/docs/zh_TW/build.md @@ -1,10 +1,11 @@ # 編譯 -此文件還提供下列的語言 [日文](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [韓文](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [俄文](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [簡體中文](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [法文](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md) and [德文](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md). + +此文件還提供下列的語言 [日文](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/build.md), [韓文](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/build.md), [俄文](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/build.md), [簡體中文](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/build.md), [法文](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/build.md), [葡萄牙](https://github.com/BoostIO/Boostnote/blob/master/docs/pt_BR/build.md) and [德文](https://github.com/BoostIO/Boostnote/blob/master/docs/de/build.md). ## 環境 -* npm: 6.x -* node: 8.x +- npm: 6.x +- node: 8.x ## 開發 @@ -25,7 +26,9 @@ $ yarn run dev ``` > ### Notice +> > There are some cases where you have to refresh the app manually. +> > 1. When editing a constructor method of a component > 2. When adding a new css class (similar to 1: the CSS class is re-written by each component. This process occurs at the Constructor method.) @@ -52,7 +55,6 @@ Distribution packages are created by exec `grunt build` on Linux platform (e.g. After installing the supported version of `node` and `npm`, install build dependency packages. - Ubuntu/Debian: ```