hub-site/README.md
Seven Of Aces b23e6f8434 new file: .dockerignore
new file:   .editorconfig
new file:   .gitignore
new file:   .prettierrc.json
new file:   .vscode/extensions.json
new file:   Dockerfile
new file:   README.md
new file:   cypress.config.ts
new file:   cypress/e2e/example.cy.ts
new file:   cypress/fixtures/example.json
new file:   cypress/support/commands.ts
new file:   cypress/support/e2e.ts
new file:   cypress/tsconfig.json
new file:   docker-compose.yml
new file:   env.d.ts
new file:   eslint.config.js
new file:   index.html
new file:   package-lock.json
new file:   package.json
new file:   postcss.config.js
new file:   public/favicon.ico
new file:   src/App.vue
new file:   src/assets/base.css
new file:   src/assets/logo.svg
new file:   src/assets/main.css
new file:   src/assets/tailwind.css
new file:   src/components/HelloWorld.vue
new file:   src/components/TheWelcome.vue
new file:   src/components/WelcomeItem.vue
new file:   src/components/__tests__/HelloWorld.spec.ts
new file:   src/components/icons/IconCommunity.vue
new file:   src/components/icons/IconDocumentation.vue
new file:   src/components/icons/IconEcosystem.vue
new file:   src/components/icons/IconSupport.vue
new file:   src/components/icons/IconTooling.vue
new file:   src/main.ts
new file:   src/router/index.ts
new file:   src/stores/counter.ts
new file:   src/views/AboutView.vue
new file:   src/views/HomeView.vue
new file:   tailwind.config.js
new file:   tsconfig.app.json
new file:   tsconfig.json
new file:   tsconfig.node.json
new file:   tsconfig.vitest.json
new file:   vite.config.ts
new file:   vitest.config.ts
2024-11-15 09:13:20 -08:00

61 lines
1.3 KiB
Markdown
Executable file

# Hub Site
This template should help get you started developing with Vue 3 in Vite.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
## 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 [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
## Customize configuration
See [Vite Configuration Reference](https://vite.dev/config/).
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Type-Check, Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
```sh
npm run test:e2e:dev
```
This runs the end-to-end tests against the Vite development server.
It is much faster than the production build.
But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments):
```sh
npm run build
npm run test:e2e
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```