Skip to content
Snippets Groups Projects
README.md 1.64 KiB
Newer Older
  • Learn to ignore specific revisions
  • Daniel Göbel's avatar
    Daniel Göbel committed
    # ProxyAPI-UI
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    This template should help get you started developing with Vue 3 in Vite.
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ## Recommended IDE Setup
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ## Type Support for `.vue` Imports in TS
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    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)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    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.
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ## Customize configuration
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    See [Vite Configuration Reference](https://vitejs.dev/config/).
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ## Project Setup
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ```sh
    npm install
    ```
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ### Compile and Hot-Reload for Development
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ```sh
    npm run dev
    ```
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ### Type-Check, Compile and Minify for Production
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ```sh
    npm run build
    ```
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ### Lint with [ESLint](https://eslint.org/)
    
    Jan Krüger's avatar
    Jan Krüger committed
    
    
    Daniel Göbel's avatar
    Daniel Göbel committed
    ```sh
    npm run lint
    ```