Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 3.03 KB

build.md

File metadata and controls

107 lines (75 loc) · 3.03 KB
Raw

Build

This page is also available in Japanese, Korean, Russain, Traditional Chinese, Simplified Chinese, French, Portuguese and German.

Environments

  • npm: 6.x
  • node: 8.x

Development

We use Webpack HMR to develop Boostnote. Running the following commands, at the top of the project directory, will start Boostnote with the default configurations.

Install the required packages using yarn.

$ yarn

Build and run.

$ 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.)

Accessing code used in Pull Requests

Visit the page for the pull request and look at the end of the url for the PR number

https://github.com/BoostIO/Boostnote/pull/2794

In the following, replace <PR> with that number (no brackets). For URLs below, you would replace <PR> with 2794

If you do not have a local copy of the master branch yet

git clone https://github.com/BoostIO/Boostnote.git
cd Boostnote
git fetch origin pull/<PR>/head:<PR>
git checkout <PR>

If you already have the master branch

git fetch origin pull/<PR>/head:<PR>
git checkout <PR>

To compile and run the code

yarn
yarn run dev

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.

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.

$ yarn add --dev grunt-electron-installer-debian grunt-electron-installer-redhat

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.