README.rst

simpleshelf: track your books

simpleshelf stores your personal library of books to read, have read, want to read, and lets you track your progress.

simpleshelf is deliberately designed for simplicity: it tracks enough information for you to identify a book, and to get more information from other sources. The (envisioned) links to OpenLibrary, the Library of Congress, and others will provide more detailed information.

Technical details

simpleshelf is a web application; it stores data in CouchDB, and presents it with a single page app served by NodeJS and written in Backbone.js.

Tools, libraries, plugins

• NodeJS
• CouchDB
• Backbone.js
• Docker
  • https://github.com/apache/couchdb-docker
  • https://hub.docker.com/_/couchdb/
• gulp

How to install

Caution!

Build instructions are currently a work-in-progress.

Development

1. Install Docker and its plugin, docker-compose.
2. Build the web app: see the Development section in Installation.

Production

1. Install Docker and its plugin, docker-compose.
2. Build the web app: see the Production section in Installation.

Configuration

Available configuration values are:

• Port to expose
• Volumes to customize

How to test

• gulp testInBrowser: runs the BrowserSync runner, launching (or updating) the test page, typically at http://localhost:3000/index.html.
• gulp testWatch: run the console and browser tests, reloading both when any code changes.

License

GNU AFFERO GENERAL PUBLIC LICENSE, Version 3 (AGPL-3.0)