Skip to content

Latest commit

 

History

History
138 lines (95 loc) · 5.04 KB

README.md

File metadata and controls

138 lines (95 loc) · 5.04 KB
Raw

Here's a README draft based on your description and the additional details about the technology stack:

Interest Calculator with Bar Chart Visualization

A simple web-based tool that allows users to calculate the growth of their savings over time based on their initial capital, interest rate, monthly savings rate, and investment period. The results are displayed as a bar chart, making it easy to visualize cumulative savings and interest over the specified period.

Table of Contents

Features

  • Customizable Inputs: Users can input:
    • Initial Capital: Starting amount in euros.
    • Interest Rate: Annual interest rate percentage.
    • Savings Rate: Monthly savings contribution.
    • Period: Duration in years.
  • Interactive Bar Chart: Shows savings growth over time, with separate bars for capital and interest.
  • Real-Time Calculations: Updates calculations and visualization immediately upon input changes.

Technologies Used

  • JavaScript: Main programming language used for logic and interactivity.
  • HTML & CSS: Used for the frontend structure and styling.
  • Chart.js: JavaScript library for rendering dynamic bar charts.
  • Vercel: Platform for easy deployment and hosting.

Usage

  1. Input Values: Enter your initial capital, interest rate, savings rate, and period in the designated fields.
  2. Calculate Growth: Click "Calculate" to view the growth projection.
  3. View Results: The bar chart will display cumulative savings growth, with distinct sections for principal and earned interest.

Contributing

  1. Fork this repository.
  2. Create a new branch for your feature (git checkout -b feature-name).
  3. Commit changes (git commit -m 'Description of feature').
  4. Push to your branch (git push origin feature-name).
  5. Open a Pull Request.

License

This project is licensed under the MIT License.

This README template provides a clear overview of the project's features, installation steps, and usage instructions. Adjust the repository URL or add additional configuration details as needed for your specific setup.Here's a README draft based on your description and the additional details about the technology stack:

Interest Calculator with Bar Chart Visualization

A simple web-based tool that allows users to calculate the growth of their savings over time based on their initial capital, interest rate, monthly savings rate, and investment period. The results are displayed as a bar chart, making it easy to visualize cumulative savings and interest over the specified period.

Table of Contents

Features

  • Customizable Inputs: Users can input:
    • Initial Capital: Starting amount in euros.
    • Interest Rate: Annual interest rate percentage.
    • Savings Rate: Monthly savings contribution.
    • Period: Duration in years.
  • Interactive Bar Chart: Shows savings growth over time, with separate bars for capital and interest.
  • Real-Time Calculations: Updates calculations and visualization immediately upon input changes.

Technologies Used

  • JavaScript: Main programming language used for logic and interactivity.
  • HTML & CSS: Used for the frontend structure and styling.
  • Chart.js: JavaScript library for rendering dynamic bar charts.
  • Vercel: Platform for easy deployment and hosting.

Installation

  1. Clone the repository: 
    git clone https://github.com/yourusername/interest-calculator.git
  2. Navigate to the project folder: 
    cd interest-calculator
  3. Install dependencies (if applicable): 
    npm install
  4. Run the application: 
    npm start
    The application will be available at http://localhost:3000 by default.

Usage

  1. Input Values: Enter your initial capital, interest rate, savings rate, and period in the designated fields.
  2. Calculate Growth: Click "Calculate" to view the growth projection.
  3. View Results: The bar chart will display cumulative savings growth, with distinct sections for principal and earned interest.

Configuration

If deploying, update any necessary settings in the .env file, such as API keys or backend endpoints.

Contributing

  1. Fork this repository.
  2. Create a new branch for your feature (git checkout -b feature-name).
  3. Commit changes (git commit -m 'Description of feature').
  4. Push to your branch (git push origin feature-name).
  5. Open a Pull Request.

License

This project is licensed under the MIT License.

This README template provides a clear overview of the project's features, installation steps, and usage instructions. Adjust the repository URL or add additional configuration details as needed for your specific setup.