Headless Investment Calculator

A headless, framework-agnostic investment calculator with compound interest, portfolio projections, and retirement planning.

What is HelpU Finance?

HelpU Finance is a free, privacy-first platform with financial tools and educational resources. No tracking, no data collection.

We believe that financial literacy should be accessible to everyone.

Installation

npm install @helpu/headless-investment-calculator

Usage

import { calculateInvestment } from '@helpu/headless-investment-calculator'

const result = calculateInvestment({
  initialInvestment: 10000,
  contributionAmount: 500,
  contributionFrequency: 'monthly',
  contributionTiming: 'end',
  annualReturnRate: 7,
  investmentYears: 10,
  compoundingFrequency: 'monthly',
})

if (result.success) {
  console.log(result.data.finalBalance)
  console.log(result.data.yearlyProjection)
} else {
  console.error(result.error.message)
}

The result includes the projected final balance, contributions, interest earned, yearly projections, and optional inflation or tax adjustments.

Testing

Install the repository dependencies and run the test suite with:

npm test

Contributing

Contributions are welcome. Please read the contribution guidelines before opening a pull request.

Support HelpU Finance through GitHub Sponsors.

License

This project is available for permitted non-commercial use under the PolyForm Noncommercial License 1.0.0.

Personal learning, education, research, experimentation, and other uses permitted by the PolyForm Noncommercial License are welcome.

Commercial use requires a separate license from Omisai Technologies.

Commercial licensing helps fund the HelpU Finance mission of creating freely accessible financial tools, educational resources, and technology.

For commercial licensing, see COMMERCIAL-LICENSING.md.

HelpU Finance is a project and brand of Omisai Technologies.