How To Install • How To Use • How To Clone • How To Run Tests • Credits • Support • License
To add these calculations to your node application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Install this repository
$ npm install alfreema/brrrr-node
In your node application, require
the plugin and call the calculate
function.
const brrrrNode = require('brrrr-node');
const strategy = {
buy: {
property: {
price: 100000,
propertyTaxRate: 1.2,
insuranceRate: 0.6,
maintenanceRate: 0.3
},
loan: {
type: 'buyAndRehabHardMoneyLoan',
loanToValueRatio: 80,
interestRate: 10,
loanTermMonths: 12,
closingCostRate: 2
}
},
rehab: {
afterRepairValue: 200000,
repairCosts: 50000,
monthsToCompleteRepairs: 6
},
rent: {
monthlyRent: 1800,
propertyManagementRate: 6,
vacancyRate: 5
},
refinance: {
loan: {
type: 'debtServiceCoverageRatioLoan',
loanToValueRatio: 75,
interestRate: 8,
loanTermMonths: 12*30,
closingCostRate: 2
}
},
repeat: {
}
}
const brrrr = brrrrNode.simulate(strategy);
console.log(brrrr)
// ...
If you would like a copy of the repository to review or run tests against you can clone the repository with:
# Clone the repository
$ git clone [email protected]:alfreema/brrrr-node
# Install dependencies
$ npm i
All functions are tested using the Jest testing framework. To run the tests:
# Run the tests
$ npm test
Note If you get any errors, please report them!
This software uses the following open source packages:
MIT
sendthisfile.com · GitHub @alfreema