Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1016 Bytes

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1016 Bytes
Raw

Contributing to Project

The only officially supported installation is via Nix package manager. Nix takes care of installing all necessary dependencies including compilers required to build the project.

Installation

Please make sure you have Nix installed on your system using instructions from official website.

After cloning this project you need to run nix-shell within project directory.

$ nix-shell

this will should build all the dependencies and start BASH in Nix environment.

Within the Nix Shell you then should be able to run following commands:

Build server to binary:

$ cabal build

Build and start server:

$ cabal run

The server should now (after also building the front-end) be reachable at http://localhost:3000.

Run ghci:

$ cabal shell

Build front-end

$ ./build-client.sh

Contributing

If you thinking about contributing to this project but don't know where to start feel free to open an issue.