Nuxtor

<p align="center"> <img width="150" src="./public/logo.png" alt="logo"> </p> <h1 align="center">NUXTOR</h1> <p align="center"> A spiritual successor of <a href="https://github.com/NicolaSpadari/vitauri">ViTauri</a>, made with <a href="https://nuxt.com">Nuxt 4</a> and <a href="https://v2.tauri.app">Tauri 2</a> <br> Build super fast desktop applications! </p> <br /> <p float="left"> <img src="https://img.shields.io/github/package-json/v/NicolaSpadari/nuxtor" /> <img src="https://img.shields.io/github/license/NicolaSpadari/nuxtor" /> </p> <br /> <div align="center"> <img src="./public/screenshot.png"> </div> <p align="center">Powered by Nuxt 4</p>

Check more screenshots at preview

<br />

Technologies run-down

• Nuxt v4
• Tauri v2
• NuxtUI v4
• TailwindCSS v4
• Typescript
• ESLint
• Auto imports (for Tauri api too!)

Functionalities

• Run shell commands from the app
• Send custom notifications to the client (remember to turn on/grant notifications in your computer settings)
• Display OS related informations
• Store and retrieve data locally
• Show tray icon
• Support all Nuxt functionalities (routing/layout/middleware/modules/etc...)

Setup

• Before running this app, you need to configure your environment with Rust. Take a look at the Tauri docs.
• This project enforces bun. In order to use another package manager you need to update package.json and tauri.conf.json
• The frontend runs on the usual port 3000 of Nuxt, the Tauri server uses the port 3001. This settings are customizable in the nuxt.config.ts and tauri.conf.json.
• Once ready, follow these commands:

# use this template
$ npx degit NicolaSpadari/nuxtor my-nuxtor-app

# go into the folder
$ cd my-nuxtor-app

# install dependencies
$ bun install

# start the project
$ bun run tauri:dev

This will run the Nuxt frontend and will launch the Tauri window.

Build

$ bun run tauri:build

This command will generate the Nuxt static output and bundle the project under src-tauri/target.

Debug

$ bun run tauri:build:debug

The same Tauri bundle will generate under src-tauri/target, but with the ability to open the console.

iOS development

• Requires a MacOS system, XCode installed
• You must first setup your environment and XCode, as per documentation
• Make sure to have created a development team in XCode and you have choosen command line tools location in settings
• You must install homebrew and through that install cocoapods
• First time only, run tauri ios init
• If everything is installed correctly, running bun tauri:ios:dev should fire up the iOS simulator and install Nuxtor
• In XCode you should set All, Debug, Release "Automatically manage signing" and choose yout personal Team
• Running bun tauri:build:ios will generate the .ipa file

Android development

• Requires Android Studio installed
• You must first setup your environment and Android SDK, as per documentation
• Make sure to have installed all SDK components and NDK as indicated
• First time only, run tauri android init
• If everything is installed correctly, running bun tauri:android:dev should fire up the Android emulator and install Nuxtor
• Running bun tauri:build:android will generate the .apk file

Notes

• Tauri v2 brings some big refactors, such as packages names and permission management. New permissions have to be granted under src-tauri/capabilities/main.json
• Tauri functions are auto imported with the help of a custom module, named like useTauri<LibraryName>. If another Tauri plugin is added, then the module has to be updated to support its functions under app/modules/tauri.ts
• As per documentation, Nuxt SSR must be disabled in order for Tauri to act as the backend. Still, all Nuxt goodies will be functional.

License

MIT License © 2024-PRESENT NicolaSpadari