Vue 3 + Typescript + Vite

Startup and installation using standard commands from the vite (scripts in package.json)

System requirements

Minimum system requirements are listed in package.json in the engines section

Info

• Сoding style is based on rules from .eslintrc.cjs
• Сheck with command before deployment: $ yarn check:eslint && yarn check:vue-tsc
• For styles and html templates use Patternfly and FloatingVue for floating elements such as popups, tooltips, dropdowns etc.

Structure

• components -
  • common - for common components like - header, footer and other
  • uikit - application components built on Patternfly
  • others folders are components from the sections of the application
• helpers - helper functions that will be used throughout the application
• i18n - plugin for translations, translations(JSON-s) are in the langs folder. Is used through the $t operator and inject('i18n') in setup-like components
• api - api generated from the openapi file (search above for it - openapi.yaml). To use structure types and methods. API works in conjunction with Axios. Access to api through services (wrapper over methods from open api). To generate api you need to use - openapi-generator, install it on the local machine and run it with the command - $ openapi-generator generate -i ../api/openapi.yaml -g typescript-axios -o ./src/api
• configs - data for structuring components, initial data
• server.ts - stub for api, for local work without api at the moment we use this file. It takes miragejs and data from the mocks folder and makes it possible to work with requests
• types - the folder contains common types for the entire application; types can also be located next to components. Core types for structures is taken and api(/api/api) generated from OpenApi
• stores - Pinia is used to organize and store data. Develop from the logic of the task, by sections, store common data used throughout the application in common storage

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.

Recommended IDE Setup

• VSCode + Volar

Type Support For .vue Imports in TS

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.

run command before deployment:

yarn check:eslint && yarn check:vue-tsc

run with mocks:

VITE_MOCK_API=true yarn start:dev

run with API:

docker run -it -p 8089:8080 optiprismio/demo:v0.1.11

VITE_API_BASE_PATH=http://localhost:8089/api yarn start:dev

build:

yarn build

generate API client:

• Doc

yarn generate:openapi