react-router

<div align="center">

<img
  src="https://reactrouter.com/_brand/react-router-brand-assets/lockup/Light.png"
  alt="React Router"
  width="400"
/>

[![npm package][npm-badge]][npm] [![build][build-badge]][build]

[Get Started](https://reactrouter.com/start/modes) · [Documentation](https://reactrouter.com/) · [Changelog](https://github.com/remix-run/react-router/blob/main/CHANGELOG.md) · [Discord](http://remix.run/discord)

</div>

[npm-badge]: https://img.shields.io/npm/v/react-router.svg
[npm]: https://www.npmjs.org/package/react-router
[build-badge]: https://img.shields.io/github/actions/workflow/status/remix-run/react-router/test-unit.yml?branch=main&style=square
[build]: https://github.com/remix-run/react-router/actions/workflows/test-unit.yml

---

# Getting Started

React Router is a multi-strategy router for React. You can use it maximally as a [Framework](https://reactrouter.com/start/framework/installation) or minimally as a [library](https://reactrouter.com/start/data/installation) with your own architecture. Check out the [Getting Started](https://reactrouter.com/start/modes) docs and choose the mode that works best for your app.

# Packages

| Package                                                          | Description         | Modes                        |
| ---------------------------------------------------------------- | :------------------ | ---------------------------- |
| [`react-router`](./packages/react-router)                        | Core                | Framework, Data, Declarative |
| [`create-react-router`](./packages/create-react-router)          | Project creation    | Framework                    |
| [`@react-router/dev`](./packages/react-router-dev)               | Development tooling | Framework                    |
| [`@react-router/node`](./packages/react-router-node)             | Node.js Adapter     | Framework                    |
| [`@react-router/serve`](./packages/react-router-serve)           | Web Server          | Framework                    |
| [`@react-router/express`](./packages/react-router-express)       | Express Adaptrer    | Framework                    |
| [`@react-router/architect`](./packages/react-router-architect)   | Architect Adapter   | Framework                    |
| [`@react-router/cloudflare`](./packages/react-router-cloudflare) | Cloudflare Adapter  | Framework                    |
| [`@react-router/fs-routes`](./packages/react-router-fs-routes)   | File-system routes  | Framework                    |

---

# Previous Versions

Looking for docs for an earlier version of React Router?

- [v7 Docs](https://reactrouter.com/v7) | [Upgrade from v7](https://reactrouter.com/v8/upgrading/v7)
- [v6 Docs](https://reactrouter.com/v6) | [Upgrade from v6](https://reactrouter.com/v7/upgrading/v6)
- [v5 Docs](https://v5.reactrouter.com/) | [Upgrade from v5](https://reactrouter.com/v6/upgrading/v5)