Home

Awesome

<div align="center"> <h1> <img src="docs/src/_static/hyper@2x.png" alt="Hyper" width="300"> </h1> </div> <p align="center"> <em>Type-safe, statically checked composition of HTTP servers</em> </p> <p align="center"> <a href="https://hyper.wickstrom.tech/docs/v0.8.0/tutorials/getting-started-with-hyper.html">Getting Started</a> | <a href="https://hyper.wickstrom.tech">Documentation</a> | <a href="https://hyper.wickstrom.tech/docs/v0.8.0/faq.html">FAQ</a> | <a href="examples/">Examples</a> </p> <hr>

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.

<p align="center"> <a href="https://travis-ci.org/owickstrom/hyper"><img alt="Build Status" src="https://travis-ci.org/owickstrom/hyper.svg?branch=master" /></a> <a href="https://pursuit.purescript.org/packages/purescript-hyper"><img alt="purescript-hyper on Pursuit" src="https://pursuit.purescript.org/packages/purescript-hyper/badge" /></a> <a href="https://github.com/purescript/package-sets"><img alt="Hyper in package-sets" src="https://img.shields.io/endpoint.svg?url=https://package-sets-badge-0lf69kxs4fbd.runkit.sh/hyper" /></a> </p> <hr>

Development Setup

Prerequisites

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