https://github.com/purescript-contrib/purescript-routing

A clean, type-safe routing library for PureScript.
https://github.com/purescript-contrib/purescript-routing

Last synced: about 1 month ago
JSON representation

A clean, type-safe routing library for PureScript.

• Host: GitHub
• URL: https://github.com/purescript-contrib/purescript-routing
• Owner: purescript-contrib
• License: apache-2.0
• Created: 2015-03-09T22:46:54.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2022-05-24T13:48:45.000Z (over 2 years ago)
• Last Synced: 2024-05-19T05:02:01.593Z (7 months ago)
• Language: PureScript
• Homepage:
• Size: 168 KB
• Stars: 104
• Watchers: 16
• Forks: 38
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Routing

[![CI](https://github.com/purescript-contrib/purescript-routing/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-routing/actions?query=workflow%3ACI+branch%3Amain)

[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-routing.svg)](https://github.com/purescript-contrib/purescript-routing/releases)

[![Pursuit](https://pursuit.purescript.org/packages/purescript-routing/badge)](https://pursuit.purescript.org/packages/purescript-routing)

[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-teal.svg)](https://github.com/garyb)

Client side routing library.

## Installation

Install `routing` with [Spago](https://github.com/purescript/spago):

```sh

spago install routing

```

## Quick start

The [guide](GUIDE.md) provides an overview of library's usage and implementation.

## Documentation

`routing` documentation is stored in a few places:

1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-routing).

2. Written documentation is kept in the [docs directory](./docs).

3. Usage examples can be found in [the test suite](./test).

If you get stuck, there are several ways to get help:

- [Open an issue](https://github.com/purescript-contrib/purescript-routing/issues) if you have encountered a bug or problem.

- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://purescript.org/chat) chat.

## Contributing

You can contribute to `routing` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-routing/issues). We'll do our best to work with you to resolve or answer it.

2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.

3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the [PureScript Discourse](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.