🪁 A simple, type-safe http server for PureScript
Go to file
Connor Prussin beb4621f4b
Update project setup (#183)
* Update project setup to use spago.

* Add license and repo info to spago.dhall

* Fix check.yaml

* Remove unused dependencies

* Remove --no-install from checks.yaml

* Minor cleanup

* Readd nix checks

* Migrate everything to spago & remove Makefile

* Split nix environment install from build in workflow

* Fix NIX_PATH

* Make build step of workflow build everything

* Fix github action

Co-authored-by: sigma-andex <sigma.andex@pm.me>
2021-11-12 23:46:59 -08:00
.github/workflows Update project setup (#183) 2021-11-12 23:46:59 -08:00
docs Migrate from purty to purs-tidy (#178) 2021-11-06 12:37:31 -07:00
src Migrate from purty to purs-tidy (#178) 2021-11-06 12:37:31 -07:00
test Migrate from purty to purs-tidy (#178) 2021-11-06 12:37:31 -07:00
.envrc #153 bind to 0.0.0.0 instead of localhost (#154) 2020-02-26 16:43:38 -08:00
.gitignore Update project setup (#183) 2021-11-12 23:46:59 -08:00
.tidyrc.json Migrate from purty to purs-tidy (#178) 2021-11-06 12:37:31 -07:00
Contributing.md Rename 'master' branch to 'main' (#173) 2021-03-22 12:34:49 -07:00
History.md Release notes for v0.12.0 2021-03-20 15:44:36 -07:00
License Clean up file naming and directory structure (#21) 2017-07-10 12:06:14 -07:00
packages.dhall Update project setup (#183) 2021-11-12 23:46:59 -08:00
Readme.md Update project setup (#183) 2021-11-12 23:46:59 -08:00
Releasing.md Rename 'master' branch to 'main' (#173) 2021-03-22 12:34:49 -07:00
shell.nix Update project setup (#183) 2021-11-12 23:46:59 -08:00
sources.json Update project setup (#183) 2021-11-12 23:46:59 -08:00
sources.nix #153 bind to 0.0.0.0 instead of localhost (#154) 2020-02-26 16:43:38 -08:00
spago.dhall Update project setup (#183) 2021-11-12 23:46:59 -08:00
test.dhall Update project setup (#183) 2021-11-12 23:46:59 -08:00

HTTPure

License Latest release purescript-httpure on Pursuit

A purescript HTTP server framework.

HTTPure is:

  • Well-tested (see our tests)
  • Well-documented (see our documentation)
  • Built to take advantage of PureScript language features for flexible and extensible routing
  • Pure (no set, get, use, etc)

Status

This project is currently fairly stable, but has not reached it's 1.0 release yet. You can track what's left before it gets there by looking at our roadmap. The API signatures are mostly stable, but are subject to change before the 1.0 release if there's a good reason to change them.

If you'd like to help us get to 1.0 quicker, please contribute! To get started, check our contributing guide.

Installation

spago install httpure

Quick Start

module Main where

import Prelude (($))

import Effect.Console as Console
import HTTPure as HTTPure

main :: HTTPure.ServerM
main =
  HTTPure.serve 8080 router $ Console.log "Server now up on port 8080"
  where
    router _ = HTTPure.ok "hello world!"

Documentation

Module documentation is published on Pursuit.

You can also take a look at our guides.

Examples

HTTPure ships with a number of examples. To run an example, in the project root, run:

make example EXAMPLE=<Example Name>

Each example's startup banner will include information on routes available on the example server.

Testing

To run the test suite, in the project root run:

make test

Contributing

We are open to accepting contributions! Please see the contributing guide.

People

HTTPure is written and maintained by Connor Prussin and Petri Lehtinen.

We are open to accepting contributions! Please see the contributing guide.

License

MIT