Skip to content

mtsokol/pollution-info-service

Repository files navigation

Pollution Info Service

Based on example-servant-elm

See it in action pollution-info-service

Example

Usage

[Important] To set up this project you need to have installed:


  1. Clone repository
$ git clone https://github.com/mat646/pollution-info-service.git
  1. Change directory to created folder
$ cd pollution-info-service/
  1. Download dependencies
$ make setup
  1. Build project
$ make build
  1. Start server
$ make server-start
  1. Go to website
http://localhost:3000/

Deployment

Project can be containerized with docker and deployed on cloud application platforms such as DigitalOcean.

[Important] To create image of project you need to have docker installed.

  1. Clone repository
$ git clone https://github.com/mat646/pollution-info-service.git
  1. Change directory to created folder
$ cd pollution-info-service/
  1. Create docker image
$ docker build -t pollution-info-service .
  1. Start image
$ docker run --rm -p 3000:3000 pollution-info-service

Tests

Included tests can be executed with stack

$ make test

Documentation

Available at: pollution-info-service-docs

Created with Haddock build in stack.

Worth seeing