varda / aule-test

Testing Travis CI deploy

Aulë

A web interface to the Varda database for genomic variation frequencies.

Warning: This is a work in progress, probably not yet ready for use!

Implementation

Aulë is a client-side JavaScript-driven interface implemented in CoffeeScript on top of the Sammy.js framework and can be served entirely as static files. RequireJS is used for modularity and Handlebars for templates.

The HTML5 layout is based on Twitter's Bootstrap with the Bootswatch Mono theme and uses Less stylesheets. Font Awesome is used for icons.

Eh, yeah, this means a somewhat modern browser is needed. Tested with Chrome 26 and Firefox 10, both on Linux.

Installation and configuration

Start by getting the source code:

git clone https://github.com/varda/aule.git
git submodule init
git submodule update

Now copy web/scripts/config.coffee.example to web/scripts/config.coffee and modify according to your needs.

Since communication between Aulë and Varda is subject to the Same origin policy, both must be served from the same site (though see the Todo note on CORS below).

The easiest way to serve Aulë is by configuring Varda to do this for you. Please see the Varda documentation for details.

Another option is to configure a web server to reverse-proxy requests for Varda and serve the static Aulë files directly. An example nginx configuration:

upstream varda {
    server 127.0.0.1:5000;
}

server {
    listen 443;
    location /aule {
        root /var/www/aule/web;
        try_files $uri /index.html;
    }
    location / {
        proxy_pass http://varda/;
    }
}

Todo

• Implement Cross-origin resource sharing (CORS) to enable serving Aulë and Varda from different sites.
• Get rid of the hard-coded absolute paths (starting with /aule) in web/index.html. This is tricky, since the request location may contain any number of / characters.
• Pre-compile Less, CoffeeScript, and Handlebars files, and use minified versions of JavaScript files.

Copyright

Manwë is licensed under the MIT License, see the LICENSE file for details. See the AUTHORS file for a list of authors.