https://github.com/siwapp/siwapp-ror

Online Invoice Management in Ruby On Rails.
https://github.com/siwapp/siwapp-ror

heroku invoice invoice-pdf invoicing invoicing-application rails ruby

Last synced: about 2 months ago
JSON representation

Online Invoice Management in Ruby On Rails.

• Host: GitHub
• URL: https://github.com/siwapp/siwapp-ror
• Owner: siwapp
• License: mit
• Created: 2012-05-20T16:31:43.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2023-07-04T00:20:32.000Z (over 1 year ago)
• Last Synced: 2024-08-08T18:26:36.453Z (5 months ago)
• Topics: heroku, invoice, invoice-pdf, invoicing, invoicing-application, rails, ruby
• Language: Ruby
• Homepage: http://www.siwapp.com
• Size: 1.77 MB
• Stars: 328
• Watchers: 34
• Forks: 186
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-starred - siwapp/siwapp-ror - Online Invoice Management in Ruby On Rails. (ruby)

README

        
# Siwapp

[![Build Status](https://travis-ci.org/siwapp/siwapp.svg?branch=master)](https://travis-ci.org/siwapp/siwapp)

Online Invoice Management. See [online demo](https://siwapp-demo.herokuapp.com) (user: [email protected], password: secret).

[API Documentation](https://github.com/siwapp/siwapp/blob/master/API_DOC.md)

## SMTP Configuration

In order to be able to send emails through the app, you must configure the following environment variables in your system:

```

SMTP_HOST

SMTP_PORT

SMTP_DOMAIN

SMTP_USER

SMTP_PASSWORD

SMTP_AUTHENTICATION (plain | login | cram_md5)

SMTP_ENABLE_STARTTLS_AUTO (set to 1 to enable it)

```

## How to Install on Heroku

First clone the siwapp repository into your computer:

    $ git clone https://github.com/siwapp/siwapp.git

    $ cd siwapp

Create the app in heroku (we suppose in the terminal your are logged

in heroku). Here we call the app "siwapp-demo", but choose whatever

you like.

    $ heroku apps:create siwapp-demo

    $ heroku apps:create --region eu --buildpack heroku/ruby siwapp-demo

    $ heroku addons:create heroku-postgresql

    $ heroku addons:create scheduler:standard

Push the code to heroku, and setup database.

    $ git push heroku

    $ heroku run rake db:setup

Finally create an user to be able to login into the app.

    $ heroku run "rake siwapp:user:create['demo','[email protected]','secret_password']"

If you want the recurring invoices to be generated automatically, you have to setup the heroku scheduler addon:

    $ heroku addons:open scheduler

Add a new job, and put "rake siwapp:generate_invoices"

That's it! You can enjoy siwapp now entering on your heroku app url.

    $ heroku apps:open