/vitesse-neutralino

πŸ• Vitesse experience for Desktop Application using Neutralino.js

Primary LanguageTypeScriptMIT LicenseMIT

Vitesse - Opinionated Vite Starter Template

Mocking up web app with Vitesse(speed)


Features


Pre-packed

UI Frameworks

  • UnoCSS - The instant on-demand atomic CSS engine.

Icons

Plugins

Coding Style

Dev tools

Variations

As this template is strongly opinionated, the following provides a curated list for community-maintained variations with different preferences and feature sets. Check them out as well. PR to add yours is also welcome!

Official

Try it now!

Vitesse requires Node >=14

GitHub Template

Create a repo from this template on GitHub.

Clone to local

If you prefer to do it manually with the cleaner git history

npx degit jaronwanderley/vitesse-neutralino my-app
cd my-app
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
neu update # If you don't have Neutralino CLI installed, run: npm i -g @neutralinojs/neu

Checklist

When you use this template, try follow the checklist to update your info properly

  • Change the author name in LICENSE
  • Change the title in App.vue
  • Remove the .github folder which contains the funding info
  • Change the manifest.name and manifest.short_name in vite.config.ts
  • Change the favicon.svg, favicon-dark.svg, favicon.ico in public
  • Change the pwa-192x192.png and pwa-512x512.png in public
  • Change applicationId in neutralino.config.json
  • Change modes.window.title in neutralino.config.json
  • Change cli.binaryName in neutralino.config.json
  • Clean up the READMEs and remove routes

And, enjoy :)

Usage

Development

To run on web browser just run and visit http://localhost:3333

pnpm dev

To run on Neutralino application with hotreloading run

pnpm neu

If is your first use on project run

pnpm build && pnpm neu

Build

To build the PWA App, run

pnpm build

And you will see the generated file in dist/www that ready to be served.

To build the Desktop Application

pnpm neu:build

Why

I have created several Vite apps recently. Setting the configs up is kinda the bottleneck for me to make the ideas simply come true within a very short time.

So I made this starter template for myself to create apps more easily, along with some good practices that I have learned from making those apps. It's strongly opinionated, but feel free to tweak it or even maintains your own forks. (see community maintained variation forks)