nurdism / electron-nuxt-boilerplate

Electron application boilerplate based on nuxt for rapid application development

electron-nuxt-boilerplate

A starter project template that combines Nuxt.js with Electron.

Screenshot

Install

• Note: requires a node version >= 8 and an npm version >= 4.

First, clone the repo via git:

git clone --depth=1 https://github.com/nurdism/electron-nuxt-boilerplate.git your-project-name

And then install dependencies with yarn.

$ cd your-project-name
$ yarn

Note: If you can't use yarn, run npm install.

Run

Start the app in the dev environment.

$ npm run dev

Packaging

To package apps for the local platform:

$ npm run package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

$ npm run package-all

To package apps with options:

$ npm run package -- --[option]

How to add modules to the project

You will need to add other modules to this boilerplate, depending on the requirements of your project. For example, you may want to add node-postgres to communicate with PostgreSQL database, or material-ui to reuse react UI components.

⚠️ Please read the following section before installing any dependencies ⚠️

Module Structure

This boilerplate uses a two package.json structure. This means, you will have two package.json files.

1. ./package.json in the root of your project
2. ./src/package.json inside src folder

Which package.json file to use

Rule of thumb is: all modules go into ./package.json except native modules. Native modules go into ./app/package.json.

1. If the module is native to a platform (like node-postgres) or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under dependencies in ./src/package.json.
2. If a module is imported by another module, include it in dependencies in ./package.json. See this ESLint rule. Examples of such modules are material-ui, redux-form, and moment.
3. Otherwise, modules used for building, testing and debugging should be included in devDependencies in ./package.json.

How to keep your project updated with the boilerplate

If your application is a fork from this repo, you can add this repo to another git remote:

git remote add upstream https://github.com/nurdism/electron-nuxt-boilerplate.git

Then, use git to merge some latest commits:

git pull upstream master

Maintainers

• Nurdism

License

MIT © Nurdism