REST server for KitchenSnitch
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
resources
src
testsuite
util
.gitignore
LICENSE
README.md
Setup.hs
changelog.md
ks-rest.cabal
stack.yaml

README.md

ks-rest

Synopsis

REST server for KitchenSnitch (Haskell)

Description

REST server for the KitchenSnitch project. This server is for accessing the back-end KS database data which is currently stored in a MongoDB instance.

Installing

Building from source

Make sure you have ghc 7.10.x, cabal-install and darcs installed.

Update your cabal list

$ cabal update

And install some native deps that cabal can't do for you

On Ubuntu:

# apt-get install --reinstall g++ 

Get the ks-rest source code

$ darcs get http://hub.darcs.net/dino/ks-rest

Update your cabal library and tools, we need a modern version

$ cabal install Cabal cabal-install

Set up a sandbox for building (if you wish to use a sandbox)

$ mkdir ~/.cabal/sandbox
$ cabal sandbox init --sandbox=/home/YOU/.cabal/sandbox/kitchensnitch

Then install the dependencies

$ cabal install --enable-tests --only-dep

This will build for quite some time, when it's done, you can build ks-download:

Building for development

$ cabal configure --enable-tests
$ cabal build
$ cabal test

And you should be good for development from here. Run it:

$ cabal run ks-rest -- PATH/TO/DIR/CONTAINING/CONF

Building for deployment

This will build everything into a deployable directory structure that you can put somewhere like /opt/ for instance.

$ cabal install --prefix=/tmp/ks-rest-VER --datasubdir=.
$ pushd /tmp
$ tar czvf ks-download-VER.tgz ks-rest-VER
$ popd

Running the server. Once you get it installed, run like this:

$ ks-rest PATH/TO/DIR/CONTAINING/CONF

Contact

Reporting Bugs

Authors

Dino Morelli dino@ui3.info

Links