Skip to content

Commit

Permalink
updated frontend README
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
tobihagemann committed Jan 9, 2024
1 parent 7c057d4 commit 5e0271f
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
# Vue 3 + Typescript + Vite
# Cryptomator Frontend

This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
This project uses Vue 3 + Typescript + Vite.

## Recommended IDE Setup

- [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar)

## Type Support For `.vue` Imports in TS
## Dev Mode

Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's `.vue` type support plugin by running `Volar: Switch TS Plugin on/off` from VSCode command palette.
You can run your application in dev mode that enables live coding using:

```shell script
npm install
npm run dev
```

## Production Build

To build an optimized (production) version of the app, run:

```shell script
npm install
npm run dist
```

0 comments on commit 5e0271f

Please sign in to comment.