warp

Warp - the fastest Linked Data resource browser.

---

Quick Start

Install Node.js and then:

$ git clone git://github.com/deiu/warp
$ cd warp
$ sudo npm -g install grunt-cli karma bower
$ npm install
$ bower install
$ grunt watch

Finally, open file:///path/to/warp/build/index.html in your browser.

Happy hacking!

Purpose

warp is the first client Web app that acts both as a resource browser app as well as a skin for data store servers (see gold). It is built around: Twitter Bootstrap, Angular UI, Angular Bootstrap, Font Awesome, and LESS. Lastly, it contains a sophisticated Grunt-based build system to ensure maximum productivity. rdflib.js - a library for working with RDF on the web. All you have to do is clone it and start coding/using it right away!

Learn

Overall Directory Structure

At a high level, the structure looks roughly like this:

warp/
  |- grunt-tasks/
  |- karma/
  |- src/
  |  |- app/
  |  |  |- <app logic>
  |  |- assets/
  |  |  |- <static files>
  |  |- common/
  |  |  |- <reusable code>
  |  |- less/
  |  |  |- main.less
  |- vendor/
  |  |- angular-bootstrap/
  |  |- bootstrap/
  |  |- placeholders/
  |- .bowerrc
  |- bower.json
  |- build.config.js
  |- Gruntfile.js
  |- module.prefix
  |- module.suffix
  |- package.json

What follows is a brief description of each entry, but most directories contain their own README.md file with additional documentation, so browse around to learn more.

• karma/ - test configuration.
• src/ - our application sources. Read more »
• vendor/ - third-party libraries. Bower will install packages here. Anything added to this directory will need to be manually added to build.config.js and karma/karma-unit.js to be picked up by the build system.
• .bowerrc - the Bower configuration file. This tells Bower to install components into the vendor/ directory.
• bower.json - this is our project configuration for Bower and it contains the list of Bower dependencies we need.
• build.config.js - our customizable build settings; see "The Build System" below.
• Gruntfile.js - our build script; see "The Build System" below.
• module.prefix and module.suffix - our compiled application script is wrapped in these, which by default are used to place the application inside a self-executing anonymous function to ensure no clashes with other libraries.
• package.json - metadata about the app, used by NPM and our build script. Our NPM dependencies are listed here.