Skip to content
Type-safe, statically checked composition of HTTP servers
PureScript Dhall Other
Branch: master
Clone or download

README.md

Hyper

Type-safe, statically checked composition of HTTP servers

Getting Started | Documentation | FAQ | Examples


Hyper is an experimental middleware architecture for HTTP servers written in PureScript. Its main focus is correctness and type-safety, using type-level information to enforce correct composition and abstraction for web servers. The Hyper project is also a breeding ground for higher-level web server constructs, which tend to fall under the “framework” category.

To learn more about Hyper, check out the documentation and the Getting Started tutorial.

Build Status purescript-hyper on Pursuit Hyper in package-sets


Development Setup

Prerequisites

  • PureScript 0.13.0 or higher
  • NodeJS
  • Spago

Build

Install dependencies and build:

spago build

Run Tests

spago test

Run Examples

# general format:
spago run -p examples/<example-name>.purs -m Examples.<example-name>

# for instance to run HelloHyper:
spago run -p examples/HelloHyper.purs -m Examples.HelloHyper

Build All Examples

make examples

Building Documentation

See docs/README.md for prerequisites, setup, and how to work with the documentation.

Then, for the release build, run:

make docs

CodeScene Status

Get more details at codescene.io.

License

Mozilla Public License Version 2.0

You can’t perform that action at this time.