mirror of
https://github.com/BoostIo/Boostnote
synced 2025-12-25 23:51:51 +00:00
87 lines
2.7 KiB
Markdown
87 lines
2.7 KiB
Markdown
# 編譯
|
||
此文件還提供下列的語言 [日文](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).
|
||
|
||
## 環境
|
||
* npm: 4.x
|
||
* node: 7.x
|
||
|
||
`$ grunt pre-build` 在 `npm v5.x` 有問題，所以只能用 `npm v4.x` 。
|
||
|
||
## 開發
|
||
|
||
我們使用 Webpack HMR 來開發 Boostnote。
|
||
|
||
在專案根目錄底下執行下列指令，將會以原始設置啟動 Boostnote。
|
||
|
||
**用 yarn 來安裝必要 packages**
|
||
|
||
```bash
|
||
$ yarn
|
||
```
|
||
|
||
**開始開發**
|
||
|
||
```
|
||
$ yarn run dev-start
|
||
```
|
||
|
||
上述指令同時運行了 `yarn run webpack` 及 `yarn run hot`，相當於將這兩個指令在不同的 terminal 中運行。
|
||
|
||
`webpack` 會同時監控修改過的程式碼，並
|
||
The `webpack` will watch for code changes and then apply them automatically.
|
||
|
||
If the following error occurs: `Failed to load resource: net::ERR_CONNECTION_REFUSED`, please reload Boostnote.
|
||
|
||
|
||
|
||
> ### 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.)
|
||
|
||
## Deploy
|
||
|
||
We use Grunt to automate deployment.
|
||
You can build the program by using `grunt`. However, we don't recommend this because the default task includes codesign and authenticode.
|
||
|
||
So, we've prepared a separate script which just makes an executable file.
|
||
|
||
This build doesn't work on npm v5.3.0. So you need to use v5.2.0 when you build it.
|
||
|
||
```
|
||
grunt pre-build
|
||
```
|
||
|
||
You will find the executable in the `dist` directory. Note, the auto updater won't work because the app isn't signed.
|
||
|
||
If you find it necessary, you can use codesign or authenticode with this executable.
|
||
|
||
## Make own distribution packages (deb, rpm)
|
||
|
||
Distribution packages are created by exec `grunt build` on Linux platform (e.g. Ubuntu, Fedora).
|
||
|
||
> Note: You can create both `.deb` and `.rpm` in a single environment.
|
||
|
||
After installing the supported version of `node` and `npm`, install build dependency packages.
|
||
|
||
|
||
Ubuntu/Debian:
|
||
|
||
```
|
||
$ sudo apt-get install -y rpm fakeroot
|
||
```
|
||
|
||
Fedora:
|
||
|
||
```
|
||
$ sudo dnf install -y dpkg dpkg-dev rpm-build fakeroot
|
||
```
|
||
|
||
Then execute `grunt build`.
|
||
|
||
```
|
||
$ grunt build
|
||
```
|
||
|
||
You will find `.deb` and `.rpm` in the `dist` directory.
|