mirror of
https://github.com/jiahaog/Nativefier
synced 2024-07-05 09:00:55 +02:00
6fb3b92eb8
* Update deps except eslint * Update eslint and lint:fix (WIP, needs manual fixing for remaining 44 problems) * Manually fix remaining eslint errors * Document deprecation of `version-string` as of electron-packager 9.0.0 * Upgrade to Electron 1.7.9 (chrome-58, node-7.9.0, v8-5.8) * npm: Disable generation of package-lock.json and gitignore it --Trying this, package-lock is a pain in PRs. May not be a good idea (obviously we lose deps pinning), will revert if necessary.-- * npm tasks: add dev-up-win for Windows developers, and e2e for end-to-end tests. Update docs. * Move normalizeUrl test to a jest unit test, makes no sense to be in the mocha e2e tests * Switch from babel-preset-es2015 to babel-preset-env, with target.node=4.0. Seem like it's today's most convenient way to support the latest ES and let babel transpile to what makes sense for our currently minimal node version
58 lines
890 B
Markdown
58 lines
890 B
Markdown
# Development
|
|
|
|
## Environment Setup
|
|
|
|
First, clone the project
|
|
|
|
```bash
|
|
git clone https://github.com/jiahaog/nativefier.git
|
|
cd nativefier
|
|
```
|
|
|
|
Install dependencies and build:
|
|
|
|
```bash
|
|
# macOS and Linux
|
|
npm run dev-up
|
|
|
|
# Windows
|
|
npm run dev-up-win
|
|
```
|
|
|
|
If dependencies are installed and you just want to re-build,
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
You can set up a symbolic link so that running `nativefier` invokes your development version including your changes:
|
|
|
|
```bash
|
|
npm link
|
|
```
|
|
|
|
After doing so (and not forgetting to build with `npm run build`), you can run Nativefier with your test parameters:
|
|
|
|
```bash
|
|
nativefier <--your-awesome-new-flag>
|
|
```
|
|
|
|
Or you can automatically watch the files for changes with:
|
|
|
|
```bash
|
|
npm run watch
|
|
```
|
|
|
|
## Tests
|
|
|
|
```bash
|
|
# To run all tests (unit, end-to-end),
|
|
npm test
|
|
|
|
# To run only unit tests,
|
|
npm run jest
|
|
|
|
# To run only end-to-end tests,
|
|
npm run e2e
|
|
```
|