Haskell-Starter-WebService

A starter for building out haskell web services. The goal of this starter is to give you something to build on top of, with some of the fiddly bits taken care of for you, while providing a featureful and robust build and dev loop.

Features

• Nix based build and dev environment
• Lots of tooling! 🔨
  • Haskell Language Server, and VS-Code integration, just install the Haskell extension
  • GHCiD
  • Hoogle
  • And more!

Using This Starter

1. Fork this repo
2. If you're on macOS or Linux, you can call ./bin/rename-things my-awesome-ws
   • If you're running another operating system you can manually replace "haskell-starter-webservice" in the following places
     • config.nix
     • default.nix
     • haskell-starter-webservice.cabal
     • README.md
   • You will also need to rename the following files
     • haskell-starter-webservice.cabal -> my-awesome-ws.cabal
3. Update your name and email in your project's freshly-renamed .cabal file
4. Run nix-build to ensure you renamed everything
5. Remove this introductory set of instructions and bin/rename-things
6. Build somethine awesome! 🚀

Building This Project

This project uses Nix for its builds.

You can build your project using nix build, your build outputs will be in the result directory.

Running the Server

Once you have built the server, you can run ./result/bin/haskell-starter-webservice.

Documentation Server

This project is able to serve swagger docs that are derived from the types of your routes and APIs. To start serving the swagger-ui, run nix-build, then ./result/bin/docserver. Swagger-ui will start running on http://localhost:8443/swagger-ui.

Continuous Integration

Basic configuration is included for the following CI providers:

• Bitbucket Pipelines: bitbucket-pipelines.yml
• CircleCI: .circleci/config.yml
• GitLab CI/CD: gitlab-ci.yml
• TravisCI: .travis.yml

Documentation

• Troubleshooting Guide
• Runbook