Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anastassia-b/bill-process
Fullstack bill processing app-- enables various account types to collaborate on bill actions before it is sent to a customer. Rails, PostgreSQL, React/Redux
https://github.com/anastassia-b/bill-process
postgresql react-redux ruby-on-rails single-page-app
Last synced: about 1 month ago
JSON representation
Fullstack bill processing app-- enables various account types to collaborate on bill actions before it is sent to a customer. Rails, PostgreSQL, React/Redux
- Host: GitHub
- URL: https://github.com/anastassia-b/bill-process
- Owner: anastassia-b
- Created: 2018-02-03T20:11:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T06:31:59.000Z (over 1 year ago)
- Last Synced: 2024-02-16T11:36:24.479Z (4 months ago)
- Topics: postgresql, react-redux, ruby-on-rails, single-page-app
- Language: Ruby
- Homepage:
- Size: 482 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Lists
- Open-Source-Ruby-and-Rails-Apps - bill-process - Fullstack bill processing app-- enables various account types to collaborate on bill actions before it is sent to a customer. Rails, PostgreSQL, React/Redux 🔥 (Happy Exploring 🤘)
README
# BillProcess
BillProcess is a full-stack app that lets different internal stakeholders efficiently process monthly customer bills. It is built with Ruby on Rails, PostgreSQL, and React/Redux.
Live demo found here!
http://billprocess.herokuapp.com/
Alternatively, to run this app locally:
* `git clone https://github.com/anastassia-b/bill-process.git`
* `bundle install`
* `npm install`
* `rails db:setup`
* `rails s`
* Visit `localhost:3000/#/welcome` in your browser!
## Features
* Complete user authentication with BCrypt gem.
* Multiple Account types (Finance, Customer Success, Sales) allow for specialized permissions and views.
* Finance users can generate bills and sent them to customers.
* CustomerSuccess and Sales can approve and reject bills.
* Bill tracks the history of actions on it, allowing for documentation and reversibility.
## Database Schema
### Users (stakeholders)
column name | data type | details
----------------|-----------|-----------------------
id | integer | not null, primary key
name | string | not null, indexed, unique
email | string |
role | string | not null
password_digest | string | not null
session_token | string | not null, indexed, unique
Implemented Roles: "Finance", "Customer Success", "Sales"
### Customers
column name | data type | details
----------------|-----------|-----------------------
id | integer | not null, primary key
csm_id | integer | foreign key (references users), indexed
name | string |
billing_address | string |
billing_email | string |
monthly_api_limit | integer |
overage_unit_cost | float |
start_date | date |
end_date | date |
require_csm_approval | boolean |
### Usage
column name | data type | details
----------------|-----------|-----------------------
id | integer | not null, primary key
customer_id | integer | not null, foreign key (references customers), indexed
month | integer |
year | integer |
api_usage | integer |
### Bill
column name | data type | details
----------------|-----------|-----------------------
id | integer | not null, primary key
customer_id | integer | not null, foreign key (references customers), indexed
month | integer |
year | integer |
overage_units | integer |
overage_unit_cost | integer |
overage_amount | integer |
status | string |
created_at | datetime |
updated_at | datetime |
A bill's overage_unit cost by default will be a customer's overage_unit_cost, but could be altered for flexibility. Therefore, overage_unit_cost is stored in two models.
### Bill Actions
column name | data type | details
----------------|-----------|-----------------------
id | integer | not null, primary key
bill_id | integer | not null, foreign key (references bills), indexed
stakeholder_id | integer | not null, foreign key (references users), indexed
action | string |
comment | string |
created_at | datetime | not null
updated_at | datetime | not null
## Routes
### HTML API
* `GET /` - loads React web app
### JSON API
#### User
* `GET /api/users/:userId`
* `POST /api/users`
#### Session
* `POST /api/session`
* `DELETE /api/session`
#### Customer
* `GET /api/customers`
* `GET /api/customers/:customerId`
#### Usage
* `GET /api/usage`
(Pass customerId, etc as parameters. Not using this route on frontend currently.)
#### Bill
* `GET /api/bills`
* `GET /api/bills/:billId`
* `POST /api/bills/`
* `PATCH /api/bills/:id/approve`
* `PATCH /api/bills/:id/reject`
Creating or updating a bill create BillActions which log the activity.
### Frontend Routes
* `/welcome` - Login and Signup Page
* `/dashboard` - Main Dashboard with Overage Bill Index
* `/bills/:id` - Bill Show Page
* `/customers` - Customer Index
* `/customers/:id` - Customer Show Page with Usage
### Future Implementation
* Error handling tied to thunk actions
* Testing
Note: Currently an assumption is that either Sales or CustomerSuccess can approve a bill. Future implementation will ensure that a bill passes through a 2-step approval system if it needs to.
### Screenshots
