readme.md 1.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
# Boostnote

Hack your memory

## Develope

1. turn on HMR server

```
npm run webpack
```

2. run hot mode

```
npm run hot
```

> `npm start` is using compiled scripts. see [Build](#Build) to compile scripts.

## Build

1. Compile scripts

compile all browser stuff(Javascript, Stylus).

```
grunt compile
```

2. Build executable

build `Boostnote.app` (OS X) / `Boostnote.exe` (Windows)

```
grunt pack:osx
grunt pack:windows
```

3. Codesign (OSX only)

codesign with Certification.

```
grunt codesign
```

> `OSX_COMMON_NAME` must be defined inside `/secret/auth_code.json`.

> codesigning on windows is included to creating installer.

4. Create installer

create installer, `Boostnote.dmg`(OSX) / `Setup.exe`(Windows).

```
grunt create-windows-installer
```

> #### Windows only
> `WIN_CERT_PASSWORD` must be defined inside `/secret/auth_code.json`.
> `/secret/authenticode_cer.p12` is required also.

5. Zip (OSX only)

zip `Boostnote.app` file.

```
grunt zip:osx
```

> Stuff(Setup.exe, .nupkg) of Windows are not needed to be zipped.

## Using stack

- Electron
- React
- Webpack
... check [`package.json`](./package.json)

## Codestyle

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

## Author

[Rokt33r(Dick Choi)](https://github.com/rokt33r)

## License

[Check here](./LICENSE).