top
(README.md)
lsmsd - lightweight storage management system daemon [![Build Status](https://travis-ci.org/openlab-aux/lsmsd.svg?branch=master)](https://travis-ci.org/openlab-aux/lsmsd)
===========
lsmsd is a storage management system designed for our local hackerspace.
___
# Installation
lsmsd requires Go 1.4 or greater. Thanks to the Go toolset the installation is very easy. Just type the following in your terminal and press Enter:

    go get github.com/openlab-aux/lsmsd

This software needs a running instance of mongoDB. For install instructions [click here](http://docs.mongodb.org/manual/installation/)

# Building a test instance with Vagrant

Spin up the box with `vagrant up`. `vagrant ssh` into the box and start lsmsd:

    cd /vagrant
    cp example_config.gcfg config.gcfg
    ./lsmsd

Leave the terminal open. Now you should be able to access the lsmsd api on your host machine on port 8080

    http loalhost:8080/items
___
# Roadmap for 0.1
  * ~~Notifications via E-Mail~~ / XMPP
  * Logging and error message overhaul
  * Better test coverage & code documentation
  * Websockets
  * Manual
  * ~~Item images (GridFS)~~

___
# Documentation

Code Documentation for this tool can be found at [godoc](http://godoc.org/github.com/openlab-aux/lsmsd).

# REST-Api Documentation

This project uses swagger to document its API.
Just run lsmsd and open `http[s]://[whereitlistens]:[PORT]/apidocs/` and type `http[s]://[whereitlistens]:[PORT]/apidocs.json` into the textfield at the top of the page.

Imports 8 package(s) ΒΆ

  1. github.com/openlab-aux/lsmsd/notification
  2. github.com/emicklei/go-restful/swagger
  3. github.com/openlab-aux/lsmsd/database
  4. github.com/emicklei/go-restful
  5. gopkg.in/gcfg.v1
  6. github.com/openlab-aux/lsmsd/webservice
  7. gopkg.in/mgo.v2
  8. github.com/Sirupsen/logrus