vue-router README

The project's README from github.com/vuejs/vue-router. As one markdown file: README.md.

vue-router Build Status

This is vue-router 3.0 which works only with Vue 2.0. and both have reached end of life.

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:

Gold Sponsors

VueJobs

Silver Sponsors

VueMastery Prefect

Bronze Sponsors

Stanislas Ormières Antony Konstantinidis Storyblok NuxtJS


Get started with the documentation, or play with the examples (see how to run them below).

Development Setup

# 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

Questions

For questions and support please use the Discord chat server or the official forum. The issue list of this repo is exclusively for bug reports and feature requests.

Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

Changelog

Details changes for each release are documented in the CHANGELOG.md file.

Stay In Touch

License

MIT

Copyright (c) 2013-present Evan You

Special Thanks

BrowserStack Logo

Special thanks to BrowserStack for letting the maintainers use their service to debug browser specific issues.

vue-router (vuejs/vue-router)

Searching Database…

What is this?It is vue-router 3.x, the official router for Vue 2 — it maps URLs to components so a Vue 2 single-page app can move between views. It is part of the Vue Ecosystem.
Is this an app I run, or a library I add to my project?A JavaScript library, not a standalone app: you install it into your Vue 2 project, where it plugs into the Vue Ecosystem alongside Vue itself.
How do I add it to my Vue 2 app?Install the vue-router package from npm (the 3.x line) and follow the documentation linked in the README; the repo also ships runnable examples you can start locally.
Do I need anything besides Vue itself to use it?Only Vue 2 itself — this 3.x line is built to work with Vue 2.0, and the npm package brings no runtime dependencies of its own.
Vue 2 is end-of-life — is it still a good pick for a new project?Not for new projects: vue-router 3 and Vue 2 have both reached end of life. For Vue 3 apps use Vue Router 4 in the vuejs/router repo; this line remains for existing Vue 2 apps.
How do I run the examples that come with the repo?Run yarn run dev — it starts node examples/server.js and serves the example apps locally. A production dist build is produced with yarn run build.
What does working on the router itself involve?yarn run test chains ESLint, Flow checks, Jasmine unit tests and a Node e2e runner, so one command lints, type-checks and tests your changes.
Creator
vuejs
Size
13.1 MB
Stars
18.9K
Age
12y
Commits · 90 Days