1
0
mirror of https://github.com/BoostIo/Boostnote synced 2025-12-13 01:36:22 +00:00

update readme

This commit is contained in:
Dick Choi
2016-08-24 10:48:42 +09:00
parent 52d065a38d
commit 93dd97a14a
6 changed files with 170 additions and 0 deletions

44
docs/build.md Normal file
View File

@@ -0,0 +1,44 @@
# Build
## Development
We use Webpack HMR to develope Boostnote.
You can use this command to use our configuration
```
npm run webpack
```
After a few seconds, you will see this message.
```
webpack: bundle is now VALID.
```
Then, we have to run the app.
```
npm run hot
```
> Actually the app can be start with `npm start@. However, the app will use the compiled scpript.
By this, webpack will watch the code changes and apply it automatically.
> ### Notice
> There are some cases you have to refresh app yourself.
> 1. When editing constructor method of a component
> 2. When adding a new css class(same to 1: CSS classs is re-written by each component. This process occurs at Constructor method.)
## Deploy
We use Grunt.
Acutal deploy can be run by `grunt`. However, you shouldn't use because the default task is including codesign and authenticode.
So, we prepare a script which just make an excutable file.
```
grunt pre-build
```
You will find the excutable from `dist`. In this case, auto updater won't work because the app isn't signed.
If you are necessary, you can do codesign or authenticode by this excutable.