https://github.com/avaray/yet-another-neutralinojs-starter

Starter for building a desktop application with Neutralinojs
https://github.com/avaray/yet-another-neutralinojs-starter

bun bun-sh daisy-ui daisyui desktop-app iconify javascript neutralino neutralinojs react tailwind tailwind-css tailwindcss typescript unocss vite webview webview-app webview2 wouter

Last synced: 2 days ago
JSON representation

Starter for building a desktop application with Neutralinojs

• Host: GitHub
• URL: https://github.com/avaray/yet-another-neutralinojs-starter
• Owner: Avaray
• License: mit
• Created: 2024-07-17T11:55:36.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-30T09:54:26.000Z (20 days ago)
• Last Synced: 2024-10-30T10:36:11.160Z (20 days ago)
• Topics: bun, bun-sh, daisy-ui, daisyui, desktop-app, iconify, javascript, neutralino, neutralinojs, react, tailwind, tailwind-css, tailwindcss, typescript, unocss, vite, webview, webview-app, webview2, wouter
• Language: TypeScript
• Homepage:
• Size: 493 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: funding.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🥱 Yet Another Neutralinojs Starter

**Highly non-opinionated** starter for building a desktop applications using [Neutralinojs](https://neutralino.js.org/docs/)

![Screenshot](web/public/screenshot.jpg)

- [Vite](https://vite.dev/) with [Hot Module Replacement](https://vitejs.dev/guide/features#hot-module-replacement) for fast development

- [React](https://react.dev/) for building user interfaces

- [TypeScript](https://www.typescriptlang.org/) for type safety

- [Wouter](https://github.com/molefrog/wouter) for routing

- [TailwindCSS](https://tailwindcss.com/) and [UnoCSS](https://unocss.dev/) for styling

- [daisyUI](https://daisyui.com/) with its awesome [components](https://daisyui.com/components/) and [themes](https://daisyui.com/docs/themes/)

- [Iconify](https://iconify.design/) with tons of vector icons

# ⚡️ How to run

1. Install [BUN](https://bun.sh/)

2. Install [Neutralino](https://neutralino.js.org/docs/#/setup/installation) CLI globally with `bun i -g @neutralinojs/neu`

3. Clone this repository

4. Install all dependencies with `bun run install`

5. Run the app in development mode with `neu run`

6. Build the app for production with `neu build`

# 😧 Known Issues

- In development mode, you will see `Global variables patch was reverted` warning in the console. This started happening after latest Neutralinojs update. It doesn't affect the app functionality but it's annoying. Currently, I don't have a solution for this.

# 👋 Credits

- This project was inspired by template of [@JustPilz](https://github.com/JustPilz/neu-react-ts-vite-template)