https://github.com/vuejs/vue-router

🚦 The official router for Vue 2
https://github.com/vuejs/vue-router

javascript router vue

Last synced: 6 days ago
JSON representation

🚦 The official router for Vue 2

• Host: GitHub
• URL: https://github.com/vuejs/vue-router
• Owner: vuejs
• License: mit
• Created: 2013-12-11T19:37:46.000Z (almost 11 years ago)
• Default Branch: dev
• Last Pushed: 2024-05-14T12:08:44.000Z (6 months ago)
• Last Synced: 2024-05-23T09:58:18.210Z (5 months ago)
• Topics: javascript, router, vue
• Language: JavaScript
• Homepage: http://v3.router.vuejs.org/
• Size: 11.6 MB
• Stars: 19,014
• Watchers: 511
• Forks: 5,079
• Open Issues: 107
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/funding.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-vue-cn - **vue-router ★1,076** - Official router for building SPAs. ^{1.0 compatible} (Awesome Vue.js [](https://github.com/sindresorhus/awesome) / Libraries & Plugins)
• awesome - vuejs/vue-router - 🚦 The official router for Vue 2 (JavaScript)
• my-awesome - vue-router - The official router for Vue.js. (JavaScript)
• awesome-vite - Vue Router
• awesome-github-star - vue-router
• awesome-frontend - vue-router
• awesome-for-beginners - Vue Router
• awesome-vue-js - Vue Router
• awesome-f2e-libs - **vue-router**
• StarryDivineSky - vuejs/vue-router
• fucking-awesome-for-beginners - Vue Router

README

        
# vue-router [![Build Status](https://img.shields.io/circleci/project/github/vuejs/vue-router/dev.svg)](https://circleci.com/gh/vuejs/vue-router)

> This is vue-router 3.0 which works only with Vue 2.0.

> - For the 1.x router see the [1.0 branch](https://github.com/vuejs/vue-router/tree/1.0).

> - For Vue Router 4 (for Vue 3) see [vuejs/router](https://github.com/vuejs/router).

Supporting Vue Router


Vue Router is part of the Vue Ecosystem and is an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:

- [Become a Sponsor on GitHub](https://github.com/sponsors/posva)

- [One-time donation via PayPal](https://paypal.me/posva)

Gold Sponsors



    

    

      

      

    

  



Silver Sponsors



    

    

      

      

    

  

    

    

      

      

    

  



Bronze Sponsors



    

    

      

      

    

  

    

    

      

      

    

  

    

    

      

      

    

  

    

    

      

      

    

  



---

Get started with the [documentation](http://v3.router.vuejs.org), or play with the [examples](https://github.com/vuejs/vue-router/tree/dev/examples) (see how to run them below).

### Development Setup

```bash

# install deps

yarn

# build dist files

yarn build

# serve examples at localhost:8080

yarn dev

# lint & run all tests

yarn test

# serve docs at localhost:8080

yarn docs

```

## Releasing

- `yarn run release`

  - Ensure tests are passing `yarn run test`

  - Build dist files `VERSION= yarn run build`

  - Build changelog `yarn run changelog`

  - Commit dist files `git add dist CHANGELOG.md && git commit -m "[build $VERSION]"`

  - Publish a new version `npm version $VERSION --message "[release] $VERSION"

  - Push tags `git push origin refs/tags/v$VERSION && git push`

  - Publish to npm `npm publish`

## Questions

For questions and support please use the [Discord chat server](https://chat.vuejs.org) or [the official forum](http://forum.vuejs.org). The issue list of this repo is **exclusively** for bug reports and feature requests.

## Issues

Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.

## Contribution

Please make sure to read the [Contributing Guide](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md) before making a pull request.

## Changelog

Details changes for each release are documented in the [`CHANGELOG.md file`](https://github.com/vuejs/vue-router/blob/dev/CHANGELOG.md).

## Stay In Touch

- For latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs)

## License

[MIT](http://opensource.org/licenses/MIT)

Copyright (c) 2013-present Evan You

## Special Thanks



  



Special thanks to [BrowserStack](https://www.browserstack.com) for letting the maintainers use their service to debug browser specific issues.