phlux/mattermostest
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update development.md

Browse Source
This commit is contained in:
Yuya Ochiai
2017-03-09 21:39:03 +09:00
parent c224936443
commit 18a0cce8fb
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/development.md
View File

@@ -9,14 +9,14 @@
- Git - Git
### Installing dependencies ### Installing dependencies
`npm install` is executed twice to install dependencies of `src/` directory. After installation, dependencies of `src/` directory are also installed.
``` ```
$ npm install $ npm install
``` ```
### Building ### Building
Build JavaScript codes with `webpack`, and copy other assets into `dist/` directory. Build JavaScript codes with `webpack`.
``` ```
$ npm run build $ npm run build
@@ -25,7 +25,8 @@ $ npm run build
After building is done, you can execute the application with `npm start`. After building is done, you can execute the application with `npm start`.
### Packaging ### Packaging
Package `dist/` directory as distributable formats with [`electron-builder`](https://github.com/electron-userland/electron-builder). Package specific files of `src/` directory as distributable formats with [`electron-builder`](https://github.com/electron-userland/electron-builder).
Files are defined in `electron-builder.json`.
Packages will be generated into `release/` directory. Packages will be generated into `release/` directory.
``` ```
@@ -78,9 +79,7 @@ $ npm run lint:js
#### `npm run watch` #### `npm run watch`
Reload the application automatically when you have saved source codes. Reload the application automatically when you have saved source codes.
When using this mode, you can use "React Developer Tools" in the Developer Tools window.
#### `mpm run prettify`
Format the source codes to pass `npm test`.
## Directory Structure ## Directory Structure
@@ -105,7 +104,6 @@ Mattermost Desktop
``` ```
### Other directories ### Other directories
- **dist/** - Built application code and asset. - **node_modules/** - Third party Node.js modules to develop and build the application.
- **node_modules/** - Third party Node.js modules to build the application.
- **release/** - Packaged distributable applications. - **release/** - Packaged distributable applications.
- **src/node_modules/** - Third party Node.js modules to use in the application. - **src/node_modules/** - Third party Node.js modules to use in the application.