README_EN.md

Vtron: A Win10 UI framework based on Vue3

Documentation | Official Website | Demo

Recommended: Vue 3 + TypeScript + Vite

English | 中文

Introduction

Vtron is a framework that allows you to create web applications with a Windows 10-like interface using Vue 3. It provides a set of components and utilities to build a desktop-like experience in the browser.

Latest Updates

Updated demo project homepage, browser, and added FLAC music player

Features

• File system: Upload, preview, edit, and save files for long-term storage
• Terminal system: Control files through a terminal interface
• JavaScript execution: Execute saved JavaScript files
• App store: Download and save applications for long-term use
• Plugin mechanism for development: Control system state

Getting Started

Using GitHub Template

1. Create a project from https://github.com/royalknight56/vtron-template
2. Clone your new project
3. Modify files in the apps directory or create new apps

Using npm in an Existing Vue Project

1. Install Vtron:

npm install vtron

2. Import styles in your main entry file:

import 'vtron/distlib/style.css';

3. Create a System instance and use VtronComputer component:

<template>
  <div class="outer">
    <VtronComputer :system="system"></VtronComputer>
  </div>
</template>
<script setup>
import { System, VtronComputer } from 'vtron';
let system = new System();
</script>

[... Rest of English documentation ...]

Contributing

We welcome contributions! Current areas where we need help:

• Documentation improvements
• Enhanced functionality towards a more complete WebOS
• See Next.md for more details

Community

Join our technical discussion group for:

• Technical exchanges
• Problem solving
• Project collaboration
• Software services

Star History