tie/README.md

53 lines
1.2 KiB
Markdown
Raw Normal View History

2022-06-12 19:10:56 +03:00
<h1 align="center">Tie</h1>
2022-03-09 18:42:39 +03:00
2022-06-12 19:10:56 +03:00
Tie allows generation of Haskell server stubs from
[OpenAPI (v 3.x) specifications](https://swagger.io/specification/).
2022-03-09 18:42:39 +03:00
2022-06-12 19:10:56 +03:00
If you are looking for a generator for Haskell client code, check out the
[Haskell-OpenAPI-Client-Code-Generator](https://github.com/Haskell-OpenAPI-Code-Generator/Haskell-OpenAPI-Client-Code-Generator)
project.
## Building Tie
2022-03-09 18:42:39 +03:00
2022-06-12 15:39:37 +03:00
Below are the steps to install Tie using the Cabal build tool.
First, you need to clone the repository
```bash
$ git clone https://github.com/scarf-sh/tie.git
$ cd tie
```
Then, you need to build it using cabal:
```bash
2022-06-12 19:10:56 +03:00
$ cabal build exe:tie
2022-06-12 15:39:37 +03:00
```
2022-06-12 19:10:56 +03:00
Finally, you can copy the resulting executable to your desired location:
2022-06-12 15:39:37 +03:00
```bash
$ cp $(cabal exec -- which tie) ~/.local/bin/tie
2022-03-09 18:42:39 +03:00
```
2022-06-12 15:39:37 +03:00
2022-06-12 19:10:56 +03:00
Alternatively, instead of manually copying the executable you can install with
cabal:
```bash
$ cabal install .
```
## Community & Contact
2022-06-12 15:39:37 +03:00
2022-06-12 19:10:56 +03:00
Feel free to join on us on our
[community Slack](https://tinyurl.com/scarf-community-slack) (#tie channel)!
2022-06-12 15:39:37 +03:00
2022-06-12 19:10:56 +03:00
## License
2022-06-12 15:39:37 +03:00
2022-06-12 19:10:56 +03:00
This program is under the terms of the [Apache License v2.0](/LICENSE).
2022-06-12 15:39:37 +03:00
2022-06-12 19:10:56 +03:00
## Authors
2022-06-12 15:39:37 +03:00
2022-06-12 19:10:56 +03:00
Tie is originally made and currently sponsored by [Scarf](https://scarf.sh)
among other [contributors](https://github.com/scarf-sh/tie/graphs/contributors).