Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ablipan/nuxtron
Create desktop applications with Nuxt and Electron
https://github.com/ablipan/nuxtron
electron nuxt nuxt3 server
Last synced: 3 days ago
JSON representation
Create desktop applications with Nuxt and Electron
- Host: GitHub
- URL: https://github.com/ablipan/nuxtron
- Owner: ablipan
- License: mit
- Created: 2023-03-22T11:03:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-03-23T01:34:39.000Z (over 1 year ago)
- Last Synced: 2023-08-28T17:06:54.365Z (about 1 year ago)
- Topics: electron, nuxt, nuxt3, server
- Language: TypeScript
- Homepage:
- Size: 98.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxtron
The best way to create desktop applications with Nuxt and Electron
## Why
1. Develop your app in the browser with hot module replacement and Vue devtools
2. Avoid tedious IPC communication between main and renderer processes
3. Write minimal main process code and restart it less often
4. Care about Electron only when you need to build and distribute your app
## Features
* 🚀 Enjoy all the benefits of Nuxt, such as SSR, server API, code splitting and more
* 📦 Start with a simple template that you can customize to your needs
## Try it now!
### GitHub Template
[Create a repo from this template on GitHub](https://github.com/ablipan/nuxtron/generate).
### Clone to local
If you prefer to do it manually with the cleaner git history
```bash
npx degit ablipan/nuxtron my-nuxt-electron-app
cd my-nuxt-electron-app
pnpm install # You can use any package manager you like
```
## Checklist
When you use this template, try follow the checklist to update your info properly
- [ ] Change the author name in `LICENSE`
- [ ] Change the name,author in `package.json`
- [ ] Change the title in `nuxt.config.ts`
- [ ] Change the title in `electron/main/createWindow.ts`
- [ ] Change the appId,productName in `electron-builder.config.cjs`
- [ ] Change the logo.svg in `public`
- [ ] Clean up the READMEs
And, enjoy :)
## Usage
### Development
Just run and visit http://localhost:3000
```bash
pnpm dev
```
### Build
To build the Nuxt, run
```bash
pnpm build
```
Then to build the Electron app, run
```bash
pnpm electron:build
```
Then package the app, run
```bash
pnpm electron:builder
```
Check the `release` folder for the packaged app.