Skip to content
Get packs

Guide · Open source

How to use core: vuejs/core install, setup and basics

Updated · written with AI from the project's own documentation and checked against our catalogue data

vuejs/core is the GitHub repository for Vue.js, an open-source JavaScript framework for building the interactive parts of websites and web apps. This guide explains what the repository is, what you need before you start, and where to find the material that actually teaches you how to use Vue. After reading it you will know whether Vue fits your project and how to get to the official documentation.

Vuevuejs/core · ★ 55k · MIT

Quick start

  1. 1Check your Node.js install. Confirm Node.js is installed on your machine, since the README lists it as a prerequisite.
  2. 2Open the official docs. Go to vuejs.org and follow the documentation for getting started, as the README directs.
  3. 3Clone the repo if you want the source. Run git clone https://github.com/vuejs/core to get the source code locally.
  4. 4Read the Contributing Guide. Before making any pull request, read .github/contributing.md in the repository.
  5. 5Ask questions in the right place. Use the official forum or community chat for help, and reserve GitHub issues for bugs and feature requests.

What is vuejs/core?

vuejs/core holds the core source code of Vue.js. The project describes Vue as a progressive, incrementally adoptable JavaScript framework for building UI on the web.

Incrementally adoptable means you can use Vue for a small part of a page or build a full application with it. You do not have to rewrite an existing site to try it.

What you need before you start

The README lists Node.js as a prerequisite but does not state which version is required, so check the official documentation for the current requirement.

Vue is distributed as a package, and the project's npm badge links to the vue package on npm. The README's install instruction is to clone the repository, which is mainly useful if you want to read or work on the source.

  • Node.js (version not specified in the README)
  • Basic familiarity with JavaScript and HTML
  • A terminal to run commands
git clone https://github.com/vuejs/core

Where to learn Vue step by step

The README's Getting Started section sends you to the official documentation at vuejs.org. That site is the right place to follow tutorials and learn the framework's concepts, rather than the source repository itself.

  • Read the official docs at https://vuejs.org/
  • Use the official forum at https://forum.vuejs.org for questions
  • Join community chat at https://chat.vuejs.org/

Where to ask for help and report problems

The issue list of this repository is reserved for bug reports and feature requests. Questions and support requests should go to the official forum or community chat instead.

Before opening an issue, the README asks you to use the new issue helper at new-issue.vuejs.org and follow its requirements. Issues that do not follow the guidelines may be closed immediately.

  • Bug reports and feature requests: GitHub issues, via the new issue helper
  • Questions and support: the forum or community chat

Check the licence and contribution rules

Vue is MIT-licensed, and the README links to the MIT licence text. The copyright line credits Yuxi (Evan) You.

If you want to contribute code, read the Contributing Guide in the repository before making a pull request. The README also invites you to add Vue-related projects to the curated list at vuejs/awesome-vue.

What people use it for

  • Building interactive user interfaces for a web page or web app
  • Adding Vue to one part of an existing site and expanding over time
  • Studying or contributing to the Vue.js source code

Frequently asked questions

Is vuejs/core free to use?

Yes. Vue.js is MIT-licensed, as stated in the README's License section. The README links to the MIT licence text.

What do I need to install vuejs/core?

The README lists Node.js as the prerequisite but does not specify a version. Clone the repository with git clone https://github.com/vuejs/core, and check the official docs at vuejs.org for setup details.

Where do I get help with Vue?

Use the official forum at forum.vuejs.org or the community chat at chat.vuejs.org. The README says the GitHub issue list is only for bug reports and feature requests.

Is Vue.js a website builder?

No. The README points to documentation for developers, so Vue is a JavaScript framework you write code with, not a ready-made website builder.

How does Vue compare to React, Svelte or Angular?

React, Svelte and Angular are comparable projects for building user interfaces. This repository does not compare them, so read each project's documentation to judge fit for your needs.

Why does my vuejs/core setup not work?

The README does not include troubleshooting steps. Check that Node.js is installed, follow the official docs at vuejs.org, and ask on the forum or community chat. Open a GitHub issue only if you have found a bug, using the new issue helper.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Vue suits developers who want an MIT-licensed, widely used frontend framework and who may adopt it gradually into an existing site. It is not a fit for non-programmers who need a ready-made website builder, and the README's support rules mean questions belong on the forum or chat, not the issue tracker.

Install options & downloads