Continue With the Guide
The guide walks you through every aspect of the framework in full detail.
There are two different ways to create a Vue application, which include:
In this section we will introduce how to scaffold a Vue Single Page Application on your local machine. The created project will be using a build setup based on Vite and allow us to use Vue Single-File Components (SFCs).
Make sure you have an up-to-date version of Node.js installed and your current working directory is the one where you intend to create a project. Run the following command in your command line:
npm create vue@latestpnpm create vue@latest// For Yarn (v1+)yarn create vue
// For Yarn Modern (v2+)yarn create vue@latest
// For Yarn ^v4.11yarn dlx create-vue@latest bun create vue@latest ✔ Project name: … <your-project-name> ✔ Add TypeScript? … No / Yes ✔ Add JSX Support? … No / Yes ✔ Add Vue Router for Single Page Application development? … No / Yes ✔ Add Pinia for state management? … No / Yes ✔ Add Vitest for Unit testing? … No / Yes ✔ Add an End-to-End Testing Solution? … No / Cypress / Nightwatch / Playwright ✔ Add ESLint for code quality? … No / Yes ✔ Add Prettier for code formatting? … No / Yes ✔ Add Vue DevTools 7 extension for debugging? (experimental) … No / Yes
Scaffolding project in ./<your-project-name>... Done.If you are unsure about an option, simply choose No by hitting enter for now. Once the project is created, follow the instructions to install dependencies and start the dev server:
cd <your-project-name> npm install npm run dev cd <your-project-name> pnpm install pnpm run dev cd <your-project-name> yarn yarn dev cd <your-project-name> bun install bun run devYou should now have your first Vue project running!
Note that the example components in the generated project are written using the Composition API and <script setup>, rather than the Options API.
Here are some additional tips:
When you are ready to ship your app to production, run the following:
npm run build pnpm run build yarn build bun run buildThis will create a production-ready build of your app in the project’s ./dist directory. Check out the Production Deployment Guide to learn more about shipping your app to production.
Next Steps >
You can use Vue directly from a CDN via a script tag:
<script src="https://unpkg.com/vue@3/dist/vue.global.js"></script>When using Vue from a CDN, there is no “build step” involved. This makes the setup a lot simpler, and is suitable for enhancing static HTML or integrating with a backend framework. However, you won’t be able to use the Single-File Component (SFC) syntax.
The above link loads the global build of Vue, where all top-level APIs are exposed as properties on the global Vue object. Here is a full example using the global build:
<! --html--> <script src="https://unpkg.com/vue@3/dist/vue.global.js"></script>
<div id="app">{{ message }}</div>
<script> const { createApp, ref } = Vue
createApp({ setup() { const message = ref('Hello vue!') return { message } } }).mount('#app') </script>Throughout the rest of the documentation, we will be primarily using ES modules syntax. Most modern browsers now support ES modules natively, so we can use Vue from a CDN via native ES modules like this:
<!-- html --> <div id="app">{{ message }}</div>
<script type="module"> import { createApp, ref } from 'https://unpkg.com/vue@3/dist/vue.esm-browser.js'
createApp({ setup() { const message = ref('Hello Vue!') return { message } } }).mount('#app') </script>Notice that we are using <script type="module">, and the imported CDN URL is pointing to the ES modules build of Vue instead.
In the above example, we are importing from the full CDN URL, but in the rest of the documentation you will see code like this:
//js import { createApp } from 'vue'vue import by using Import Maps: <!--html --> <script type="importmap"> { "imports": { "vue": "https://unpkg.com/vue@3/dist/vue.esm-browser.js" } } </script>
<div id="app">{{ message }}</div>
<script type="module"> import { createApp, ref } from 'vue'
createApp({ setup() { const message = ref('Hello Vue!') return { message } } }).mount('#app') </script>You can also add entries for other dependencies to the import map - but make sure they point to the ES modules version of the library you intend to use.
As we dive deeper into the guide, we may need to split our code into separate JavaScript files so that they are easier to manage.
For example:
<div id="app"></div>
<script type="module"> import { createApp } from 'vue' import MyComponent from './my-component.js'
createApp(MyComponent).mount('#app') </script> import { ref } from 'vue' export default { setup() { const count = ref(0) return { count } }, template: `<div>Count is: {{ count }}</div>`}index.html in your browser, you will find that it throws an error because ES modules cannot work over the file:// protocol, which is the protocol the browser uses when you open a local file. http:// protocol, which is what the browsers use when opening pages on the web. In order for ES modules to work on our local machine, we need to serve the index.html over the http:// protocol, with a local HTTP server. If you skipped the Introduction, we strongly recommend reading it before moving on to the rest of the documentation.