trantor/README

Imperial Library of Trantor

The Imperial Library of Trantor (also known as Galactic Library) is a repository management system of ebooks on ePub format.

You can check out the main development branch from GitLab at:

https://gitlab.com/trantor/

(We still in pre-beta fase)

== Dependences ==

In order to run Trantor, you need to install the following packages:

* Go language
* Mongodb (>= 2.6)
* Bazaar
* Git

Under Debian Wheezy you can simply run:

# aptitude install golang-go git mercurial bzr mongodb

Yo also need to install go dependences:

# go get gopkg.in/mgo.v2 gopkg.in/mgo.v2/bson github.com/gorilla/sessions \
         github.com/gorilla/securecookie github.com/gorilla/mux \
         github.com/nfnt/resize github.com/cihub/seelog \
         code.google.com/p/go.crypto/scrypt \
         github.com/rainycape/cld2

== Installation ==
=== For admins ("for developers" below) ===

Now you can install Trantor itself:

# go get -tags prod gitlab.com/trantor/trantor

You can run trantor in /srv/www/trantor i.e. For this:

# mkdir -p /srv/www/trantor

# cd /srv/www/trantor

# ln -s $GOPATH/src/pkg/gitlab.com/trantor/trantor/templates/ templates
# ln -s $GOPATH/src/pkg/gitlab.com/trantor/trantor/css/ css
# ln -s $GOPATH/src/pkg/gitlab.com/trantor/trantor/js/ js
# ln -s $GOPATH/src/pkg/gitlab.com/trantor/trantor/img/ img

Now you can run it:
# $GOPATH/bin/trantor

Go to your browser to: http://localhost:8080

=== For developers ===

Edit config.go if you want to change the port and other configuration, by default is 8080

Now you can compile Trantor:
$ go build -tags prod
(remove '-tags prod' for a faster compilation without language guessing)

Now you can run it:
$ ./trantor

Go to your browser to: http://localhost:8080

== Bugs ==

Please, report bugs in the gitlab issue tracker:
https://gitlab.com/trantor/trantor/issues

== Rights ==

All the matterial of this project is under WTFPL as described on the LICENSE 
file with the exception of:
- css/bootstrap.min.css css/bootstra-responsive.min.css js/bootstrap.min.js 
  img/glyphicons-halflings-white.png img/glyphicons-halflings.png
  From the bootstrap framework: http://twitter.github.com/bootstrap/
- js/jquery.js
  From jquery library: http://jquery.com/
- js/Chart.min.js
  From chart.js library: http://www.chartjs.org/
- img/bright_squares.png
  From subtlepatterns: http://subtlepatterns.com/bright-squares/
- css/FredokaOne.ttf css/PTSerif.ttf
  From Google Web Fonts: http://www.google.com/webfonts