Vue 3 + TypeScript + Vite

August 17, 2023 ยท View on GitHub

Usage

Development mode

  1. Install dependencies:

    npm i

  2. Run the app in the development mode:

    npm run dev

    The page will reload if you make edits.

  3. Update the WEBAPP_URL environment variable

    Since Telegram only accepts HTTPS URLs for Web Apps, you'll need to use a tunneling software like serveo or ngrok (list of tunnelling software and services):

    # serveo usage example (no client required)
ssh -R 80:localhost:5173 serveo.net

# ngrok usage example
ngrok http 5173

    Note: 5173 is default port. If the port differs from 5173, change it accordingly.

    Set the environment variable WEBAPP_URL to obtained link.

Production mode

  1. Install dependencies:

    npm i

  2. Build the app for production to the dist folder:

    npm run build

  3. Deploy the dist folder to any static hosting provider.

  4. Set the environment variable WEBAPP_URL to your link.

Vue 3 + TypeScript + Vite

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 to learn more.

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.