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

Add docs/development.md

Browse Source
This commit is contained in:
Yuya Ochiai
2016-09-25 19:45:52 +09:00
parent 566b983f92
commit 3a8720a9bd
2 changed files with 102 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -57,39 +57,8 @@ Or you can set proxy by following command line options.
* `--proxy-server=<SERVER>:<PORT>`
* `--proxy-pac-url=<URL>`
## Testing and Development
Node.js is required to test this app.
### Simple testing
1. Clone or download the source code.
2. Run `npm install`.
3. Run `npm start`.
When you edit `src/**` files, please execute `npm run build` before `npm start`.
### Development
###### `npm run watch`
Reload the app automatically when you have saved source codes.
###### `npm test`
Run tests with Mocha.
## Packaging
You can package this app with following commands. Packages will be created in `release` directory.
```
$ npm run package (for your platform)
$ npm run package:windows (Requires Windows or Wine)
$ npm run package:osx (Requires OS X or Linux)
$ npm run package:linux
$ npm run package:all (Packages for all platform)
```
Create a windows installer with the following command. It will appear in the `release\windows-installer` directory.
```
$ npm run installer
```
## Contributing
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).
## Development
Please see [docs/development.md](./docs/development.md).