Kakeibo Sanataro <img src=“https://secure.travis-ci.org/kaznum/sanataro.png” /> <img src=“https://gemnasium.com/kaznum/sanataro.png”/>¶ ↑

Sanataro - Simple Web Household Account Book. built with Ruby on Rails.

Functional Features¶ ↑

• Simple kakeibo Web Application.

• Multi-User capable

• Balance adjustment

• Lightweight and beautiful monthly/yearly P/L and B/S charts

• Credit-card due setting

• Simple input User-Interface for iPhone.

• Tweet button. (Think why this exists and how to enjoy this individually.)

• See more on a demo page. sanataro.heroku.com/

Architectual Features¶ ↑

• Only HTML, CSS, JavaScript. No Flash, No ActiveX.

• Locale Support (Now only Japanese, but you can add your own language easily)

Requirement¶ ↑

• Ruby:

  • MRI (tested continuously with 2.3, 2.5, 2.6)

• Ruby on Rails: 4.2 (Check Gemfile for the minor version)

• DB:

  • MySQL

  • SQLite3

  • PostgreSQL (Heroku available. Demo: sanataro.heroku.com/ )

• Gem: See Gemfile

• Heroku Installation Guide (see github.com/kaznum/sanataro/wiki/Deploying-to-heroku)

If you want to try instantly…¶ ↑

• ‘git clone git://github.com/kaznum/sanataro.git’

• ‘cd sanataro’

• ‘cp config/database.yml.sample config/database.yml’

• ‘gem install bundler’ if bundler is not installed.

• ‘bundle install’

• ‘rake db:migrate’

• ‘rake db:seed’ if you use ‘demo’ user (password: demo123).

• ‘rails s’

• Visit localhost:3000 with your favorite web browser.

• Some other configurable parameters are in config/environments/*.rb or config/application.yml

  • /admin/users has basic authentication. Credential username and password can be setup by ADMIN_USER and ADMIN_PASSWORD in environment variables or production’s admin_user and admin_password settings in config/application.yml (see development setting).

  • SECRET_TOKEN should be set in config/application.yml for each environments in config/application.yml. This can be generated by executing ‘rake secret`

Caution: For Production Environment¶ ↑

• You should set following configurations as the environment variables or config/application.yml settings (In application.yml, the parameter names have to be small characters (ex. admin_user for ADMIN_USER))

  • ADMIN_USER: user name for admin page

  • ADMIN_PASSWORD: user password for admin page

  • SECRET_TOKEN: the secret token (It is good to use the result of ‘rake secret`)

For JRuby environment¶ ↑

• Use gemfiles/Gemfile.jruby{,.lock} as Gemfile{,.lock}

For JRuby and SQL Server 2008 (Not Official support)¶ ↑

• Insert ‘gem ’activerecord-jdbcmssql-adapter’‘ into Gemfile and execute `bundle install`

• Edit ‘config/database.yml` for the connection to SQL Server Database (see `config/database.yml.sample`)

For MRI and SQL Server 2014 / Azure SQL Database (v12) (Not Official support)¶ ↑

• Insert ‘gem ’tiny_tds’ into Gemfile

• Insert ‘gem ’activerecord-sqlserver-adapter’ into Gemfile

• Execute ‘bundle install`

• Put ‘config/initializers/azure.rb` which has contents as follows,

“‘

ActiveRecord::ConnectionAdapters::SQLServerAdapter.lowercase_schema_reflection = true

“‘

• Edit ‘config/database.yml` for the connection to SQL Server Database (see `config/database.yml.sample`)

RESTful API¶ ↑

• See github.com/kaznum/sanataro/wiki/RESTful-API

Credit¶ ↑

• Author: Kazuya NUMATA <[email protected]>.

• Copyright © 2007-2016 Kazuya NUMATA.

License¶ ↑

The MIT License (MIT)

Copyright © 2007-2015 Kazuya NUMATA <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The bundled libraries¶ ↑

This product uses the following libraries. (These are bundled with, so you don’t need additional installation.)

• Farbtastic 1.2

  • Copyright © Steven Wittens

  • GPL v2 (GPL Document is in doc directory)

  • acko.net/blog/farbtastic-jquery-color-picker-plug-in/

• jquery.delayedObserver.js (from jQuery-utils)

  • jquery-utils.googlecode.com/svn/trunk/src/jquery.delayedObserver.js

  • MIT License

• Flot

  • code.google.com/p/flot/

  • MIT License

• Emolett

  • mayuco.github.com/emolett/

  • SIL Open Font License (OFL)

• EJS Embedded JavaScript Framework

  • code.google.com/p/embeddedjavascript/

  • MIT License

• ActsAsTaggableRedux(Refered to as tagging practice architectually)

  • github.com/geemus/acts_as_taggable_redux

  • Copyright © 2010 geemus(Wesley Beary), released under the MIT license

  • Some code and design concepts in lib/sanataro_taggable comes from ActsAsTaggableRedux.