Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saltyshiomix/nuxtron
⚡ Nuxt.js + Electron ⚡
https://github.com/saltyshiomix/nuxtron
electron nextron nuxt nuxtron viteron vue
Last synced: 3 months ago
JSON representation
⚡ Nuxt.js + Electron ⚡
- Host: GitHub
- URL: https://github.com/saltyshiomix/nuxtron
- Owner: saltyshiomix
- License: mit
- Archived: true
- Created: 2018-10-06T17:58:26.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-03T08:54:01.000Z (almost 4 years ago)
- Last Synced: 2024-07-20T15:08:17.363Z (4 months ago)
- Topics: electron, nextron, nuxt, nuxtron, viteron, vue
- Language: TypeScript
- Homepage: https://npm.im/nuxtron
- Size: 1000 KB
- Stars: 217
- Watchers: 13
- Forks: 13
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Build a [Nuxt.js](https://nuxtjs.org/) + [Electron](https://electronjs.org/) app for speed ⚡
(The screenshot above is a top page of [examples/with-javascript](./examples/with-javascript).)
## Support
| nuxtron | nuxt |
| --- | --- |
| `v0.x` | `v2.x` |
## My Belief for Nuxtron
1. Show a way of developing desktop apps only web knowledge
1. Easy to use
1. Be transparent and open to OSS developers
## Usage
### Install
```bash
$ npm install --global nuxtron
```
### Create Application
To create `my-app`, just run the command below:
```bash
$ nuxtron init my-app
```
### Create Application with Template
You can use `examples/*` apps as a template.
To create the `examples/with-typescript` app, run the command below:
```bash
$ nuxtron init my-app --example with-typescript
```
### Development Mode
Run `npm run dev`, and nuxtron automatically launches an electron app.
```json
{
"scripts": {
"dev": "nuxtron"
}
}
```
### Production Build
Run `npm run build`, and nuxtron outputs packaged bundles under the `dist` folder.
```json
{
"scripts": {
"build": "nuxtron build"
}
}
```
### Build Options
To build Windows 32 bit version, run `npm run build:win32` like below:
```json
{
"scripts": {
"build": "nuxtron build",
"build:all": "nuxtron build --all",
"build:win32": "nuxtron build --win --ia32",
"build:win64": "nuxtron build --win --x64",
"build:mac": "nuxtron build --mac --x64",
"build:linux": "nuxtron build --linux"
}
}
```
**CAUTION**: To build macOS binary, your host machine must be macOS!
### Build Configuration
Edit `electron-builder.yml` properties for custom build configuration.
```yml
appId: com.example.nuxtron
productName: My Nuxtron App
copyright: Copyright © 2019 Shiono Yoshihide
directories:
output: dist
buildResources: resources
files:
- from: .
filter:
- package.json
- app
publish: null
```
For more information, please check out [electron-builder official configuration documents](https://www.electron.build/configuration/configuration/).
## Examples
See [examples](./examples) folder for more information.
Or you can start the example app by `nuxtron init --example `.
To list all examples, just type the command below:
```bash
$ nuxtron list
```
### [examples/custom-build-options](./examples/custom-build-options)
```bash
$ nuxtron init my-app --example custom-build-options
```
### [examples/with-javascript](./examples/with-javascript)
```bash
$ nuxtron init my-app --example with-javascript
```
### [examples/with-typescript](./examples/with-typescript)
```bash
$ nuxtron init my-app --example with-typescript
```
## Develop `examples/*`
```bash
$ git clone https://github.com/saltyshiomix/nuxtron.git
$ cd nuxtron
$ yarn
$ yarn dev
```
## Related
- [Nextron](https://github.com/saltyshiomix/nextron) - ⚡ Electron + NEXT.js ⚡