Skip to content
This repository has been archived by the owner on Oct 4, 2023. It is now read-only.

Commit

Permalink
[docs] update electron-packager ignore, add note about fixing electro…
Browse files Browse the repository at this point in the history
…n version (#60) [skip ci]
  • Loading branch information
SimulatedGREG committed Nov 8, 2016
1 parent b728f0d commit 0f418c8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/building_your_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ electron-vue makes use of [electron-packager](https://github.com/electron-userla
icon: path.join(__dirname, '../app/icons/icon'),

// Ignore files that would bloat final build size
ignore: /node_modules|src|index.ejs|icons/,
ignore: /\b(node_modules|src|index\.ejs|icons)\b/,

// `config.js` name
name: config.name,
Expand Down
11 changes: 6 additions & 5 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@ npm run dev

When running `npm install` a post install script is also executed, which will `npm install` inside the `app` directory as well.


> Why is there another `package.json`?
electron-vue uses a two package.json setup. Find out more [here](https://simulatedgreg.gitbooks.io/electron-vue/content/docs/project_structure.html).
electron-vue uses a **two `package.json`** setup. Find out more [here](https://simulatedgreg.gitbooks.io/electron-vue/content/docs/project_structure.html).

#### On the subject of electron
electron-vue requires the use of electron `>= v1.2.3`. The `v1.2.3` release adds support for more [`chrome.*` APIs](https://github.com/electron/electron/releases/tag/v1.2.3) that `vue-devtools` depends upon. If you are needing a previous release of electron before `v1.2.3`, then you will need to manually uninstall [`electron-devtools-installer`](https://github.com/SimulatedGREG/electron-vue/blob/master/template/package.json#L36) from `./package.json` and revert `./app/electron.js` to a previous version found [here](https://github.com/SimulatedGREG/electron-vue/commit/e7175ee0337f3af36de49aef10cf58a64d75a220).

Although optional, it is recommended to lock in your electron version after scaffolding your project. This helps prevent other developers working on the same project developing on different versions. Electron makes releases quite often so features are always subject to change. [More Info](http://electron.atom.io/docs/tutorial/electron-versioning/).

#### A note for Windows Users
If you run into errors during `npm install` about `node-gyp`, then you most likely do not have the proper build tools installed on your system. Build tools include items like Python and Visual Studio. Thanks to [@felixrieseberg](https://github.com/felixrieseberg), there are a few packages to help simplify this process.
Expand All @@ -29,6 +33,3 @@ The first item we need to check is our npm version and ensure that it is not out
Once that is complete, we can then continue to setup the needed build tools. Using [`windows-build-tools`](https://github.com/felixrieseberg/windows-build-tools), most of the dirty work is done for us. Installing this globally will in turn setup Visual C++ packages, Python, and more.

At this point things should successfully install, but if not then you will need a clean installation of Visual Studio. Please note that these are not direct problems with electron-vue itself. (Windows can be difficult sometimes ¯\\\_(ツ)\_/¯)

#### On the subject of electron
electron-vue requires the use of electron `>= v1.2.3`. The `v1.2.3` release adds support for more [`chrome.*` APIs](https://github.com/electron/electron/releases/tag/v1.2.3) that `vue-devtools` depends upon. If you are needing a previous release of electron before `v1.2.3`, then you will need to manually uninstall [`electron-devtools-installer`](https://github.com/SimulatedGREG/electron-vue/blob/master/template/package.json#L36) from `./package.json` and revert `./app/electron.js` to a previous version found [here](https://github.com/SimulatedGREG/electron-vue/commit/e7175ee0337f3af36de49aef10cf58a64d75a220).
4 changes: 2 additions & 2 deletions docs/global_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

electron-vue uses the [webpack](https://github.com/webpack/webpack) module loader system for pre-processing, bundling, and building your app. The default settings are rather common and should meet most of your needs. An additional `config.js` is provided in the root directory for quick adjustments. Further customization can be made by directly adjusting `webpack.config.js`.

#### ``config.js``
#### `config.js`
```js
{
// Name of electron app
Expand All @@ -23,7 +23,7 @@ electron-vue uses the [webpack](https://github.com/webpack/webpack) module loade
asar: true,
dir: path.join(__dirname, 'app'),
icon: path.join(__dirname, 'app/icons/icon'),
ignore: /node_modules|src|index.ejs|icons/,
ignore: /\b(node_modules|src|index\.ejs|icons)\b/,
name: pkg.name,
out: path.join(__dirname, 'builds'),
overwrite: true,
Expand Down

0 comments on commit 0f418c8

Please sign in to comment.