{"id":15063892,"url":"https://github.com/cdepillabout/servant-rawm","last_synced_at":"2025-08-11T17:07:55.418Z","repository":{"id":53754337,"uuid":"104714090","full_name":"cdepillabout/servant-rawm","owner":"cdepillabout","description":"Effectful Raw handler for Servant servers.","archived":false,"fork":false,"pushed_at":"2021-03-16T02:21:34.000Z","size":202,"stargazers_count":16,"open_issues_count":5,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-15T14:11:18.549Z","etag":null,"topics":["hacktoberfest","haskell","raw","servant"],"latest_commit_sha":null,"homepage":"https://hackage.haskell.org/package/servant-rawm","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cdepillabout.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-25T06:54:52.000Z","updated_at":"2023-01-19T05:25:23.000Z","dependencies_parsed_at":"2022-09-11T16:31:52.659Z","dependency_job_id":null,"html_url":"https://github.com/cdepillabout/servant-rawm","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/cdepillabout/servant-rawm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdepillabout%2Fservant-rawm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdepillabout%2Fservant-rawm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdepillabout%2Fservant-rawm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdepillabout%2Fservant-rawm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cdepillabout","download_url":"https://codeload.github.com/cdepillabout/servant-rawm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdepillabout%2Fservant-rawm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269922906,"owners_count":24496999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","haskell","raw","servant"],"created_at":"2024-09-25T00:08:30.401Z","updated_at":"2025-08-11T17:07:55.395Z","avatar_url":"https://github.com/cdepillabout.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Servant.RawM\n\n[![CI](https://github.com/cdepillabout/servant-rawm/actions/workflows/ci.yml/badge.svg)](https://github.com/cdepillabout/servant-rawm/actions/workflows/ci.yml)\n[![Hackage](https://img.shields.io/hackage/v/servant-rawm.svg)](https://hackage.haskell.org/package/servant-rawm)\n[![Stackage LTS](http://stackage.org/package/servant-rawm/badge/lts)](http://stackage.org/lts/package/servant-rawm)\n[![Stackage Nightly](http://stackage.org/package/servant-rawm/badge/nightly)](http://stackage.org/nightly/package/servant-rawm)\n![BSD3 license](https://img.shields.io/badge/license-BSD3-blue.svg)\n\n`servant-rawm` provides a way to embed a WAI\n[`Application`](https://hackage.haskell.org/package/wai-3.2.1.1/docs/Network-Wai.html#t:Application)\nin a Servant handler. It is more convenient and powerful than the\n[`Raw`](https://hackage.haskell.org/package/servant-0.11/docs/Servant-API-Raw.html#t:Raw)\ntype provided by [`servant`](https://hackage.haskell.org/package/servant).\n\nSee the\n[Haddocks on Hackage for `servant-rawm`](https://hackage.haskell.org/package/servant-rawm/docs/Servant-RawM.html)\nfor an explanation of how to use the\n[`RawM`](https://hackage.haskell.org/package/servant-rawm/docs/Servant-RawM.html#t:RawM)\ntype.\n\nAfter `servant-rawm` 1.0.0.0, the implementations of the `RawM` endpoint are\ndivided into `servant-rawm-client`, `servant-rawm-docs`, and\n`servant-rawm-server` to avoid introducing unnecessary dependencies and reduce\nthe compilation overhead.\n\nYou will need to add either of the implementations to your dependencies, and\nimport the corresponding implementation (`Servant.RawM.Server`,\n`Servant.RawM.Client`, or `Servant.RawM.Docs`) for the `RawM` endpoint to\nfunction correctly.\n\n## Example\n\nThere is code for an example server, client, and documentation located\nin [`servant-rawm-examples-and-tests/example/`](servant-rawm-examples-and-tests/example/). The following section describes how to run the\nexample executables.\n\n### Building\n\nThe example executables can be built with the following command:\n\n```sh\n$ stack build servant-rawm-examples-and-tests\n```\n\n### Server\n\nAfter building, the server can be run with the following command:\n\n```sh\n$ stack exec -- servant-rawm-example-server\n```\n\nThis runs a server on port 8201 serving files\nin [`servant-rawm-examples-and-tests/example/files/`](servant-rawm-examples-and-tests/example/files/).\n\nIt can be accessed from `curl` like the following:\n\n```sh\n$ curl http://localhost:8201/serve-directory/foo.txt\nThis is an example text file.\n```\n\n### Client\n\nAfter building and running the server, the client can be run like the following:\n\n```sh\n$ stack exec -- servant-rawm-example-client\nSuccessfully got file ./example/files/foo.txt:\n\nThis is an example text file.\n```\n\n### Documentation\n\nAfter building, the documentation can be generated like the following. This is\ndocumentation for the API defined in\n[servant-rawm-examples-and-tests/example/Api.hs](servant-rawm-examples-and-tests/example/Api.hs):\n\n```sh\n$ stack exec -- servant-rawm-example-docs\n...\n```\n\n## Maintainers\n\n- [@cdepillabout](https://github.com/cdepillabout)\n- [@Krasjet](https://github.com/Krasjet)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdepillabout%2Fservant-rawm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcdepillabout%2Fservant-rawm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdepillabout%2Fservant-rawm/lists"}