replanadu

A hack to navigate tiddlyspace replies

#Contributing

Running the Application

1. Check out this repository.
2. Install tsapp via pip: pip install -U tsapp.
3. Run make lib to fetch dependencies.
4. Run tsapp serve and navigate to http://localhost:8080/About.html

You should also install Node.js if you want to run tests and JS linting.

All code apart from the Sass files lives in assets.

Testing Against Another Space

You can edit .tsapp and chance the target_server property to point to a space of your choice. This means you will be able to navigate to your tiddlers via http://localhost:8080/<TiddlerName> and see how replanadu affects those tiddlers.

Space Inclusion

Include replanadu in your space.

Create/edit the HtmlJavascript tiddler and add the following:

/bags/replanadu_public/tiddlers/twiddlerscount.js

Navigating to any tiddler e.g. /GettingStarted should load the replanadu icon. Clicking on it will load the related tiddlers view.

Generating CSS

To generate the required CSS you will need Ruby and the Compass gem:

gem install compass

Then run:

make compass

This will produce/overwrite replanadu.css in the assets folder. At present, both Sass and CSS files need to be committed.

Testing

Command line

make test

This downloads the test dependencies (if not already there) and runs the tests via PhantomJS

In Browser

If the test dependencies haven't yet been downloaded:

make testlib

Run a local web server and load test/SpecRunner.html into a browser.

Deployment

make deploy

You will need to be a member of the replanadu space to deploy assets to it. If you are, make sure you have run tsapp auth once, prior to deployment.