readme.md 2.3 KB
Newer Older
1 2
# Boostnote

R
Rokt33r 已提交
3
Simple note app
4

R
Rokt33r 已提交
5 6 7 8 9 10 11 12
## Progress Kanban

https://trello.com/b/wJlinZJx/boostnote-todo-list

This is a public Kanban board. Also everyone can comment here.

If you want to join us, ask me to add you.

R
Rokt33r 已提交
13
## System requirement
D
Dick Choi 已提交
14

R
Rokt33r 已提交
15
This app is built on Electron.
D
Dick Choi 已提交
16

R
Rokt33r 已提交
17 18
You can check it from [here](https://github.com/electron/electron/blob/master/docs/tutorial/supported-platforms.md).

R
Rokt33r 已提交
19 20
Currently, I'm testing this app on Windows 10(64bit), OS X El Capitan, Ubuntu Linux, Arch Linux.

R
Rokt33r 已提交
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
## About note storage

Currently, Boostnote stores data to a single json file.

You can find it from the path below.

OS X
```
/Users/$USER_NAME$/Library/Application Support/boost/local.json
```

Windows
```
C:\Users\$USER_NAME$\AppData\Roaming\boost\local.json
```

On v0.6.0, You will be able to select any folder in your file system.
D
Dick Choi 已提交
38

R
Rokt33r 已提交
39
## Develop
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

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.

R
Rokt33r 已提交
55

56 57
## Build

R
Rokt33r 已提交
58 59 60
> '3. Codesign' and '4. Create' installer are needed to deploy this app.
> You can skip these steps.

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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
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)

R
Rokt33r 已提交
119

120 121 122 123 124 125
## Codestyle

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

## Author

R
Rokt33r 已提交
126 127 128
[Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r)

## Copyright & License
129

R
Rokt33r 已提交
130
Copyright (C) 2016 MAISIN&CO.
131 132 133 134

[Check here](./LICENSE).