2
2
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-06-03 05:10:47 +00:00
nativefier/docs/development.md
Ronan Jouchet 6fb3b92eb8
Upgrade dependencies and default to latest Electron 1.7.9 (PR #483)
* 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
2017-11-14 08:05:01 -05:00

890 B

Development

Environment Setup

First, clone the project

git clone https://github.com/jiahaog/nativefier.git
cd nativefier

Install dependencies and build:

# macOS and Linux
npm run dev-up

# Windows
npm run dev-up-win

If dependencies are installed and you just want to re-build,

npm run build

You can set up a symbolic link so that running nativefier invokes your development version including your changes:

npm link

After doing so (and not forgetting to build with npm run build), you can run Nativefier with your test parameters:

nativefier <--your-awesome-new-flag>

Or you can automatically watch the files for changes with:

npm run watch

Tests

# 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