|
5 | 5 | We're super excited to be teaming up with the community to build a SaaS Project Management App together!
|
6 | 6 |
|
7 | 7 | Use this repo to keep up with the code as it's being worked on live by event speakers.
|
| 8 | + |
| 9 | +You can merge changes from this repo into your own working project by adding it as a remote: |
| 10 | + |
| 11 | +``` |
| 12 | +git remote add speakers [email protected]:vueschool/vuejs-forge-the-project.git |
| 13 | +``` |
| 14 | + |
| 15 | +and then pulling and merging (if you've made updates to your own codebase, you may need to resolve any resulting merge conflicts) |
| 16 | + |
| 17 | +``` |
| 18 | +git pull speakers main |
| 19 | +``` |
| 20 | + |
| 21 | +# Project Setup |
| 22 | + |
| 23 | +This template should help get you started developing with Vue 3 in Vite. |
| 24 | + |
| 25 | +## Recommended IDE Setup |
| 26 | + |
| 27 | +[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). |
| 28 | + |
| 29 | +## Type Support for `.vue` Imports in TS |
| 30 | + |
| 31 | +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. |
| 32 | + |
| 33 | +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: |
| 34 | + |
| 35 | +1. Disable the built-in TypeScript Extension |
| 36 | + 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette |
| 37 | + 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)` |
| 38 | +2. Reload the VSCode window by running `Developer: Reload Window` from the command palette. |
| 39 | + |
| 40 | +## Customize configuration |
| 41 | + |
| 42 | +See [Vite Configuration Reference](https://vitejs.dev/config/). |
| 43 | + |
| 44 | +## Project Setup |
| 45 | + |
| 46 | +```sh |
| 47 | +npm install |
| 48 | +``` |
| 49 | + |
| 50 | +### Compile and Hot-Reload for Development |
| 51 | + |
| 52 | +```sh |
| 53 | +npm run dev |
| 54 | +``` |
| 55 | + |
| 56 | +### Type-Check, Compile and Minify for Production |
| 57 | + |
| 58 | +```sh |
| 59 | +npm run build |
| 60 | +``` |
| 61 | + |
| 62 | +### Run Unit Tests with [Vitest](https://vitest.dev/) |
| 63 | + |
| 64 | +```sh |
| 65 | +npm run test:unit |
| 66 | +``` |
| 67 | + |
| 68 | +### Run End-to-End Tests with [Cypress](https://www.cypress.io/) |
| 69 | + |
| 70 | +```sh |
| 71 | +npm run build |
| 72 | +npm run test:e2e # or `npm run test:e2e:ci` for headless testing |
| 73 | +``` |
| 74 | + |
| 75 | +### Lint with [ESLint](https://eslint.org/) |
| 76 | + |
| 77 | +```sh |
| 78 | +npm run lint |
| 79 | +``` |
0 commit comments