A simple web application to create and send invoices, receive payments, manage clients and companies. It generates reports of Item sales, payments, and collected revenues. It supports multi languages and multi currencies. This application is developed in Ruby on Rails v4.1.8. and Ruby v2.0.0. This document describe the OSB application setup on ubuntu 14.04 LTS machine.

• A nice looking Dashboard with graph and key metrics
• Create and send invoices to your clients
• Create and send estimates to your clients
• Create/Manage expenses
• Time Tracking for running projects
• Generate invoice from project log hours
• Convert estimate to invoice
• Recurring invoices
• Receive payments against sent invoices
• Partial payments tracking
• Receive payments through Paypal and credit card
• Invoice dispute handling
• Manage billing for your multiple sister companies under one account
• Export invoices to PDF
• Export estimates to PDF
• Import data from Freshbooks
• Reports like Payments Collected, Aged Accounts Receivable, Revenue By Client, Items Sales and more to come

This is 2.0 release. You may contribute by having any suggesstion or reporting the bugs you find.

MySql is an open-source relational database management system. Run the following command to install database:

sudo apt-get install mysql-server mysql-client libmysqlclient-dev

Git is version control system we used for OSB. Run the following command to install git.

sudo apt-get install git

Run the following command to install ruby dependencies:

sudo apt-get update

sudo apt-get install git-core curl zlib1g-dev build-essential libssl-dev libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev python-software-properties libffi-dev libncurses5-dev automake libtool bison libffi-dev imagemagick libmagickcore-dev libmagickwand-dev libicu-dev

You may need access to dependent pecl libraries, most which can be found by

sudo add-apt-repository ppa:ondrej/php

Run the following commands to install stable version:

curl -L https://get.rvm.io | bash -s stable

source ~/.rvm/scripts/rvm

rvm install 2.0.0

rvm use 2.0.0 --default

Bundler is a tool that allows you to install multiple gem versions, run this command to install bundler:

gem install bundler

Run this command to install rails:

gem install rails -v 4.1.8

To clone project code from github, give your github account credential for authentication while cloning project.

git clone https://github.com/vteams/open-source-billing

cd open-source-billing

bundle install

Copy config/database.yml.sample to config/database.yml and set your mysql username/password. After that run following command from terminal to createMySQL database specified in database.yml file.

rake db:create

rake db:migrate

Loading default values in database

rake db:seed

Copy config/config.yml.copy to config/config.yml and set your configuration

Edit config/config.yml with your own paypal settings:

paypal_login: YOUR_PAYPAL_LOGIN
paypal_password: YOUR_PAYPAL_PASSWORD
paypal_signature: YOUR_PAYPAL_SIGNATURE
paypal_business: YOUR_PAYPAL_BUSINESS

Edit config/config.yml with your own application settings:

 app_host: 'APP_HOST_HERE' # e.g. osb.mydomain.com
 app_protocol: http

Using following command in terminal to get path of wkhtmltopdf library path that is already installed on system.

which wkhtmltopdf

Edit config/config.yml with your own application wkhtmltopdf path.

wkhtmltopdf_path: YOUR_WKHTMLTOPDF_PATH

Edit config/config.yml with your own application smtp settings.

 smtp_setting:
     address: 'smtp.gmail.com'
     port: 587
     authentication: :plain,
     enable_starttls_auto: true,
     user_name: 'YOUR_EMAIL_HERE',
     password: 'YOUR_PASSWORD_HERE'

Your application is ready to use. Run rails server using following command:

rails server

and use your application in browser by typing in url: localhost:3000

You can also configure Apache, Nginx or any other web/application server of your choice to execute OSB in production mode.

1. Fork it
2. Create your feature branch (git checkout -b my-awesome-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-awesome-feature)
5. Create new Pull Request

Teena Liberman +1 (858) 586 7777

E-mail: [email protected] | [email protected] | [email protected]

Homepage: https://www.opensourcebilling.org/