Bluemedia/ScanOS
1
0
Fork 0
mirror of https://github.com/BluemediaGER/ScanOS.git synced 2024-11-13 21:15:30 +01:00
Code Issues Packages Projects Releases Wiki Activity
ScanOS/frontend
History
Oliver Traber b9d5c06956
Initial commit
2023-09-21 14:56:01 +02:00
..
.vscode Initial commit 2023-09-21 14:56:01 +02:00
src Initial commit 2023-09-21 14:56:01 +02:00
.eslintrc.cjs Initial commit 2023-09-21 14:56:01 +02:00
.gitignore Initial commit 2023-09-21 14:56:01 +02:00
.prettierrc.json Initial commit 2023-09-21 14:56:01 +02:00
env.d.ts Initial commit 2023-09-21 14:56:01 +02:00
index.html Initial commit 2023-09-21 14:56:01 +02:00
package.json Initial commit 2023-09-21 14:56:01 +02:00
postcss.config.js Initial commit 2023-09-21 14:56:01 +02:00
README.md Initial commit 2023-09-21 14:56:01 +02:00
tailwind.config.js Initial commit 2023-09-21 14:56:01 +02:00
tsconfig.app.json Initial commit 2023-09-21 14:56:01 +02:00
tsconfig.json Initial commit 2023-09-21 14:56:01 +02:00
tsconfig.node.json Initial commit 2023-09-21 14:56:01 +02:00
vite.config.ts Initial commit 2023-09-21 14:56:01 +02:00
yarn.lock Initial commit 2023-09-21 14:56:01 +02:00

README.md

ScanOS frontend

This folder contains the frontend of ScanOS. It is built using Vue 3 in Vite and Tailwind CSS. The frontend runs inside Chromium on the scanner.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Project Setup

yarn install

Compile and Hot-Reload for Development

yarn dev

Type-Check, Compile and Minify for Production

yarn build

Lint with ESLint

yarn lint