https://github.com/mirkobrombin/vnt

Vue Native Toolkit (vnt) simplifies the development of applications across web, desktop, and mobile platforms. Designed to mimic traditional native toolkits, it supports multiple engines (Tauri, Wails, Electron..) and offers widgets that behave like native components for seamless integration in any project.
https://github.com/mirkobrombin/vnt

Last synced: about 6 hours ago
JSON representation

Vue Native Toolkit (vnt) simplifies the development of applications across web, desktop, and mobile platforms. Designed to mimic traditional native toolkits, it supports multiple engines (Tauri, Wails, Electron..) and offers widgets that behave like native components for seamless integration in any project.

• Host: GitHub
• URL: https://github.com/mirkobrombin/vnt
• Owner: mirkobrombin
• Created: 2024-04-09T21:17:19.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-19T12:07:20.000Z (7 months ago)
• Last Synced: 2024-05-01T18:28:55.284Z (6 months ago)
• Language: Vue
• Homepage:
• Size: 18.9 MB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  
Vue Native Toolkit



### How is vnt native?

The term **native** in vnt does not mean that the components are rendered natively but instead refers to how they behave and how they are structured, trying to mimic the components of other native toolkits in multiple aspects.

### How to use vnt?

vnt is currently in early development and not yet published to npm. To use it, you can use this repository as a dependency in your package.json file.

```json

{

  "dependencies": {

    "vnt": "git+https://github.com/mirkobrombin/vnt.git"

  }

}

```

and then run `npm install` or `pnpm install` to install the package and its dependencies.

In your Vue project, you can use vnt as a plugin in your entry file.

```javascript

import { createApp } from "vue";

import App from "./App.vue";

import vnt from "vnt";

import TauriEngine from 'vnt/lib/engines/Tauri'

import { Window } from '@tauri-apps/api/window'

const app = createApp(App)

app.use(vnt, new TauriEngine(Window.getCurrent())) // or any other supported engine

app.mount("#app");

```

### How to make desktop apps with vnt?

The idea is to use vnt together with tools like [Tauri](https://tauri.app/), [Wails](https://wails.io/) or [Electron](https://www.electronjs.org/). Currently only Tauri is officially supported, but the other two should work as well with some caveats.

### Is vnt for desktop apps only?

No, vnt is designed to be used in any Vue.js project, including web apps and mobile apps.

## Documentation

To be written.

## License

vnt is licensed under the GPL-3.0 license. Some of the assets used in the project may have different licenses, for example the [Noto Sans](https://fonts.google.com/noto/specimen/Noto+Sans/about) and the [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Icons) fonts. Please refer to the respective licenses for more information.