{"id":13549316,"url":"https://github.com/vteams/open-source-billing","last_synced_at":"2025-04-02T22:31:49.262Z","repository":{"id":7705565,"uuid":"9070270","full_name":"vteams/open-source-billing","owner":"vteams","description":"Open Source Billing a super simple way to create and send invoices and receive payments online. ","archived":false,"fork":false,"pushed_at":"2024-03-25T13:09:03.000Z","size":10010,"stargazers_count":727,"open_issues_count":23,"forks_count":402,"subscribers_count":78,"default_branch":"master","last_synced_at":"2024-11-03T18:34:51.563Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://opensourcebilling.org","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vteams.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-03-28T04:49:34.000Z","updated_at":"2024-11-02T15:42:31.000Z","dependencies_parsed_at":"2024-01-13T16:23:53.098Z","dependency_job_id":"cf57dda9-411e-45d6-89bc-0d926c59db5e","html_url":"https://github.com/vteams/open-source-billing","commit_stats":{"total_commits":2095,"total_committers":31,"mean_commits":67.58064516129032,"dds":0.7770883054892601,"last_synced_commit":"0667e47a8e5867a0f293ffecc44bccf74dca5331"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vteams%2Fopen-source-billing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vteams%2Fopen-source-billing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vteams%2Fopen-source-billing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vteams%2Fopen-source-billing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vteams","download_url":"https://codeload.github.com/vteams/open-source-billing/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246905218,"owners_count":20852812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T12:01:20.595Z","updated_at":"2025-04-02T22:31:44.246Z","avatar_url":"https://github.com/vteams.png","language":"HTML","funding_links":[],"categories":["HTML","others","Happy Exploring 🤘"],"sub_categories":[],"readme":"\nOpenSourceBilling\n===================\n\n[OpenSourceBilling](http://opensourcebilling.org/) is 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 v6.0.2.2. and Ruby v2.7.1. This document describes OSB application setup on Ubuntu 14.04 LTS machine and Windows OS 10.\n\nFeatures\n---------\n\n* Attractive, responsive and adaptive user interface\n* A nice looking dashboard with graph and key metrics\n* Create and send invoices to your clients\n* Recurring invoices\n* Export invoices to PDF\n* Create and send estimates to your clients\n* Convert estimate to invoice\n* Export estimates to PDF\n* Receive payments against sent invoices\n* Partial payments tracking\n* Receive payments through Paypal and credit card\n* Filters for listing pages\n* Full text search feature using elastic search\n* Time Tracking for running projects\n* Generate invoice from project log hours\n* Manage billing for your multiple sister companies under one account\n* Import data from Freshbooks and QuickBooks\n* Reports like `Payments Collected`, `Aged Accounts Receivable`, `Revenue By Client`, `Items Sales` and more to come\n* Customer portal\n\nTry [Demo](http://demo.opensourcebilling.org) here\n\nCaveats\n-------\nThis is `2.0` release. You may contribute by having any suggestion or reporting the bugs you find.\n\n## Installation step - Ubuntu\n### Step-1. Dependencies\n#####  1.1 MySQL\nMySql is an open-source relational database management system. Run the following command to install database:\n\n    sudo apt-get install mysql-server mysql-client libmysqlclient-dev\n\n#### 1.2 Git\nGit is version control system we used for OSB. Run the following command to install git.\n    \n    sudo apt-get install git\n    \n### Step-2. Ruby Installation Using RVM\n\n#### 2.1 Dependencies for Ruby\nRun the following command to install ruby dependencies:\n\n    sudo apt-get update\n\n    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\n\nYou may need access to dependent pecl libraries, most which can be found by\n\n    sudo add-apt-repository ppa:ondrej/php\n    \n#### 2.2 Ruby using RVM (development version)\nRun the following commands to install stable version:\n\n    curl -L https://get.rvm.io | bash -s stable\n\n    source ~/.rvm/scripts/rvm\n\n    rvm install 2.7.1\n\n    rvm use 2.7.1 --default\n\n#### 2.3 Installing Bundler\nBundler is a tool that allows you to install multiple gem versions, run this command to install bundler:\n\n    gem install bundler\n\n## Installation - Windows \n\n### Step-1. Dependencies\n#####  1.1 MySQL\nDownload Mysql libraries and dependencies from mysql windows installer\n**https://dev.mysql.com/downloads/windows/installer/5.7.html**\n\n#### 1.2 Git\nGit is version control system we used for OSB. Visit the following link to download git installer.\nAfter downloading please double click to open exe and follow the steps asked for installations.\n\n**https://git-scm.com/download/win**\nMake sure you download the correct file based on your OS bit system i.e 32 or 64. \n### Step-2. Ruby Installation Using Ruby Installer\n\n#### 2.1 Ruby Installer\nTo install ruby on windows operating system we need rubyinstaller. Since there is no ruby version control system for windows so have to\ndownload correct version from the link below. \n\nSteps: \n\n**First** -\u003e Visit the link: https://rubyinstaller.org/downloads/\n\n**Second** -\u003e Download ruby 2.7.1 from the options \n\n**Third** -\u003e After downloading installer open the package exe and follow the instructions to install ruby. \n#### 2.2 Installing Bundler\nBundler is a tool that allows you to install multiple gem versions, run this command to install bundler:\n\n    gem install bundler\n\n\n### Step-3. Configurations\n\n#### 3.1 Clone Application Code\nTo clone project code from GitHub, give your GitHub account credential for authentication while cloning project.\n    \n    git clone https://github.com/vteams/open-source-billing\n\n\n#### 3.2 Navigate to Project Directory\n\n    cd open-source-billing\n\n#### 3.3 Installing Gems\n\n    bundle install\n\n#### 3.4 Installing Yarn\n\n    yarn install\n\n#### 3.5 Configuration PayPal (Optional, for paypal payments integration)\nCopy config/config.yml.copy to config/config.yml to set your configurations.\n\nEdit config/config.yml with your own paypal settings:\n\n    paypal:\n      signature: YOUR_PAYPAL_SIGNATURE\n      business: YOUR_PAYPAL_BUSINESS\n\n#### 3.6 Configuration Application host and protocol\nEdit config/config.yml with your own application settings:\n\n    app_host: APP_HOST_HERE # e.g. osb.mydomain.com\n    app_protocol: http\n\n#### 3.7 PDF configuration\nUsing following command in terminal to get path of wkhtmltopdf library path that is already installed on system.\n\n    which wkhtmltopdf\nEdit config/config.yml with your own application wkhtmltopdf path.\n\n    wkhtmltopdf_path: YOUR_WKHTMLTOPDF_PATH\n\n#### 3.8 SMTP configuration\nTo make smtp_settings, go to settings, open a company edit form by clicking on a company and provide your smtp details in Mail Config section.\n\n\n#### 3.9 QuickBooks configuration\nEdit config/config.yml with your own QuickBooksApp's oauth_consumer_key and oauth_consumer_secret.\n\n     quickbooks:\n       # QuickBooksApp's account key and secret\n       consumer_key: YOUR_QUICKBOOKS_APP_CLIENT_ID\n       consumer_secret: YOUR_QUICKBOOKS_APP_CLIENT_SECRET\n\n#### 3.10 Secret key configuration\n\nRun following command on terminal to generate secret key\n\n     rake secret\n\ncopy this (newly generated) secret key from terminal and past it to the value of encryption_key in config.yml file.\n\n     encryption_key: ENTER-YOUR-ENCRYPTED-KEY-HERE\n\n#### 3.11 Configuring Database\nCopy config/database.yml.copy to config/database.yml and set your mysql username/password. After that run following command from terminal to create MySQL database specified in database.yml file.\n\n    rails db:create\n\n#### 3.12 Tables schema and seeding\n\n    rails db:migrate\n\nLoading default values in database\n\n    rails db:seed\n\n### Step-4. Run\n#### 4.1 Background Services\nYou need to start delayed_job for email delivery and other background tasks required for properly functionality of OSB by using following command\n\n    RAILS_ENV=development  bin/delayed_job start\n\n#### 4.2 Development Environment\nYour application is ready to use.  Run rails server using following command:\n\n    rails server\n\nand use your application in browser by typing in url: localhost:3000\n\n#### 4.2 Production Environment\n\nYou can also configure Apache, Nginx or any other web/application server of your choice to execute OSB in production mode.\n\nLogin credentials\n------------\n\nOnce you successfully configured OSB, you can use the below credentials to login.\n\n    Email: admin@opensourcebilling.org\n    password: opensourcebilling\n   \nYou can immediately change the credentials once you successfully logged in.    \n\nCustomer Portal\n------------\n\nWhen a customer receive invoice/estimate through email, he will also receive a login link to see all of his invoices. By visiting that url he can login to his account or can create his account if he don't have one.  \n\nContributing\n------------\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-awesome-feature`)\n3. Commit your changes (`git commit -am 'Added some feature'`)\n4. Push to the branch (`git push origin my-awesome-feature`)\n5. Create new Pull Request\n\nContact Information\n-------------------\nMia Mian\n+1 (858) 586 7777\n\nE-mail: \u003cmia@presstigers.com\u003e | \u003csaadat@presstigers.com\u003e | \u003csupport@presstigers.com\u003e\n\nHomepage: \u003chttp://www.opensourcebilling.org/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvteams%2Fopen-source-billing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvteams%2Fopen-source-billing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvteams%2Fopen-source-billing/lists"}