Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.64 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.64 KB
Raw

Description

Tiny Web Service for Parsing Cabal Files

Helper service for bibliothecary to parse cabal files from various sources. Provides a fiat JSON represenation for a given cabal file posted to this HTTP API.

Getting Started

Developer documentation can be generated with:

cabal haddock --executables

Once the documentation is generated, it is available at: ./dist/doc/html/cabal-parser/cabal-parser/index.html.

Locally with docker-compose

This project is setup to run with docker-compose. Running the following command will build a docker image (includes building cabal-parser), and start all requisite services as docker containers.

docker-compose up -d

cabal-parser will be available at http://localhost:PORT once this command finishes executing. You can get PORT from docker ps.

Locally with nix-shell

This project is setup with nix-shell. Running the following command will build a local development environment where all of the supplementary tools are pre-installed.

nix-env -i cabal
nix-shell

Once this command finishes executing, the libraries and other tools are available. You will still need to have cabal installed another way.

Others

This project utilizes cabal like most Haskell projects and the standard Haskell development environment for your platform should work just fine.