https://github.com/arpansaha13/vilectron
Opinionated nuxt-electron starter template
https://github.com/arpansaha13/vilectron
electron nuxt3 starter-template typescript
Last synced: 11 months ago
JSON representation
Opinionated nuxt-electron starter template
- Host: GitHub
- URL: https://github.com/arpansaha13/vilectron
- Owner: arpansaha13
- License: mit
- Created: 2022-03-12T07:34:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T14:17:03.000Z (over 1 year ago)
- Last Synced: 2025-07-28T01:39:44.336Z (11 months ago)
- Topics: electron, nuxt3, starter-template, typescript
- Language: TypeScript
- Homepage:
- Size: 554 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vilectron
Opinionated nuxt-electron starter template
❤ Inspired from [nuxt-electron-trpc-prisma](https://github.com/gurvancampion/nuxt-electron-trpc-prisma)
## Nuxt 3 Modules
- [NuxtUI](https://ui.nuxt.com) - A UI Library for Modern Web Apps.
- [VueUse](https://vueuse.org) - Collection of Vue Composition Utilities.
- [Pinia](https://pinia.vuejs.org) - The Vue Store that you will enjoy using.
- [Headless UI](https://headlessui.com) - Completely unstyled, fully accessible UI components, designed to integrate beautifully with Tailwind CSS.
- [Image](https://v1.image.nuxtjs.org) - Plug-and-play image optimization for Nuxt apps.
> These are the pre-packed modules in this starter template. Feel free to ditch any module you won't be using.
## Nuxt UI Modules
These modules are pre-packed with the Nuxt UI module.
- [TailwindCSS](https://tailwindcss.com/) - Rapidly build modern websites without ever leaving your HTML.
- [Color mode](https://color-mode.nuxtjs.org) - Dark and Light mode with auto-detection made easy with Nuxt 🌗.
- [Icon](https://nuxt.com/modules/icon) - Icon module for Nuxt with 100,000+ ready to use icons from Iconify.
> Nuxt UI includes components powered by Headless UI, but the [nuxt-headlessui](https://nuxt.com/modules/headlessui) module is also added separately to enable native Headless UI syntax and functionality.
## Other Features
- [pnpm](https://pnpm.io/) - Fast, disk space efficient package manager.
- [Prettier](https://prettier.io/) - Opinionated code formatter.
- [TypeScript](https://www.typescriptlang.org/) - Why not?
# Quick start
### Run dev server
Run the dev server in an electron app:
```bash
pnpm dev
```
### Build the app
Build the electron app:
```bash
pnpm build
```
# Checklist
When you use this template, try to follow the checklist to update your info properly
- [ ] Change the author name in `LICENSE`
- [ ] Remove `` in `pages/index.vue`
- [ ] Change `author`, `name`, `version` and `description` in `package.json`
- [ ] Remove or change `repository` and `bugs` in `package.json`
- [ ] Clean up the READMEs
- [ ] Remove any modules you won't be needing.