Kawaii single-page web interface for BnW
CoffeeScript CSS Makefile HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

bnw-meow meow

Build Status

Kawaii single-page web interface for BnW built on top of great Chaplin framework.

See it in action

https://meow.bnw.im/

Use with bnw.im

Send the following message to the bot:

set baseurl https://meow.bnw.im

Now all links that you get from bot will have correct prefix.

Manual build

You could easily build and host you own version of bnw-meow. bnw-meow uses Brunch for build automation so you will need nodejs and npm installed.

Quick & dirty way

% sudo npm install -g brunch bower
% git clone https://github.com/Kagami/bnw-meow.git && cd bnw-meow
% npm install && bower install
% cp app/scripts/config.coffee.example app/scripts/config.coffee
% brunch build     # Build development version in public/
% brunch watch -s  # Auto-recompile changed files, run server at http://localhost:4000/
% brunch build -P  # Build minified version in public/

A bit cleaner and more detailed guide

Preparing steps

# Install required binary dependencies in case of Debian.
% make install-debian-deps
# Install node and bower dependencies.
% make install-deps
# Initialize default application config.
# You could then adjust settings in app/scripts/config.config if you want.
% make config

Build types

  • Development version

    % make

    It will build development version of the static in the public/ directory.

  • Product version

    % make release

    It will build product version of the static in the build/srv/bnw-meow/ directory.

  • Debian package

    % make deb

    It will build debian package with the product static in the deb_dist/ directory.

Web server configuration

bnw-meow uses HTML5 history API so you will need some rewrite rules. See bnw-meow.cfg for nginx example.

Development

  • Watch

    % make watch

    It will start development web server at http://localhost:4000/ and auto-recompile changed files.

  • Test

    % make test

License

bnw-meow - kawaii single-page web interface for BnW

Written in 2013-2017 by Kagami Hiiragi kagami@genshiken.org and bnw-meow contributors

To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.

You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.