2017-08-07 11:08:39 +00:00
# reitit [](https://travis-ci.org/metosin/reitit) [](https://jarkeeper.com/metosin/reitit)
2017-08-17 05:54:54 +00:00
A friendly data-driven router for Clojure(Script).
2017-08-07 11:08:39 +00:00
2017-10-29 07:29:06 +00:00
* Simple data-driven [route syntax ](https://metosin.github.io/reitit/basics/route_syntax.md )
* [Route conflict resolution ](https://metosin.github.io/reitit/advanced/route_conflicts.md )
* First-class [route meta-data ](https://metosin.github.io/reitit/basics/route_data.md )
* Bi-directional routing
* [Pluggable coercion ](https://metosin.github.io/reitit/ring/parameter_coercion.md ) ([clojure.spec](https://clojure.org/about/spec))
* supports both [Middleware ](https://metosin.github.io/reitit/ring/compiling_middleware.md ) & Interceptors
2017-08-08 12:31:00 +00:00
* Extendable
* Fast
2017-08-17 06:24:23 +00:00
Ships with example router for [Ring ](#ring ). See [Issues ](https://github.com/metosin/reitit/issues ) for roadmap.
2017-08-07 11:08:39 +00:00
## Latest version
[](http://clojars.org/metosin/reitit)
2017-09-14 13:33:36 +00:00
## Documentation
2017-08-07 11:08:39 +00:00
2017-09-14 13:33:36 +00:00
[Check out the full documentation! ](https://metosin.github.io/reitit/ )
2017-08-11 04:48:55 +00:00
2017-08-08 12:31:00 +00:00
## Special thanks
To all Clojure(Script) routing libs out there, expecially to
[Ataraxy ](https://github.com/weavejester/ataraxy ), [Bide ](https://github.com/funcool/bide ), [Bidi ](https://github.com/juxt/bidi ), [Compojure ](https://github.com/weavejester/compojure ) and
2017-08-09 07:36:57 +00:00
[Pedestal ](https://github.com/pedestal/pedestal/tree/master/route ).
2017-08-07 11:08:39 +00:00
2017-09-08 05:29:39 +00:00
Also to [Compojure-api ](https://github.com/metosin/compojure-api ), [Kekkonen ](https://github.com/metosin/kekkonen ) and [Ring-swagger ](https://github.com/metosin/ring-swagger ) and for the data-driven syntax, coercion & stuff.
And some [Yada ](https://github.com/juxt/yada ) too.
2017-09-14 13:58:39 +00:00
## Development instructions
The documentation is built with [gitbook ](https://toolchain.gitbook.com ). To preview your changes locally:
```bash
npm install -g gitbook-cli
2017-09-18 04:36:02 +00:00
gitbook install
2017-09-14 13:58:39 +00:00
gitbook serve
```
2017-10-29 07:30:48 +00:00
To raise the version:
```bash
# new version
./scripts/set-version "1.0.0"
./scripts/lein-modules install
# works
lein test
# deploy to clojars
./scripts/lein-modules do clean, deploy clojars
```
2017-08-07 11:08:39 +00:00
## License
2017-08-08 12:31:00 +00:00
Copyright © 2017 [Metosin Oy ](http://www.metosin.fi )
2017-08-07 11:08:39 +00:00
Distributed under the Eclipse Public License, the same as Clojure.
