README.md file for Interest-Calculator-JS-React-GitHub-Bash-Scripts github-final-project

Written by Brian Mccarthy

A professional calculator that calculates simple interest given principal, annual rate of interest, and time period in years. This project was developed for the Micro-finance startup mission to empower low-income individuals.

Functions & Logic

The core function calculates the yield on an investment or loan using the simple interest formula:

• Input:
  • p: Principal amount
  • t: Time period in years
  • r: Annual rate of interest
• Output:
  • simple interest = (p * t * r) / 100

Technologies Used

• Frontend: React (JavaScript), Tailwind CSS for styling.
• Animations: Motion (formerly Framer Motion).
• Icons: Lucide React.
• Scripting: Bash (Shell Scripting).
• Version Control: Git & GitHub.

Project Tasks

1. Create a GitHub repository with a README and Apache 2.0 License.
2. Implement a Code of Conduct (CODE_OF_CONDUCT.md).
3. Implement Contribution Guidelines (CONTRIBUTING.md).
4. Develop a Bash script (simple-interest.sh) for interest calculation.
5. Demonstrate Git CLI operations (forking, branching, merging, reverting, and pull requests).

Submission Parts

Part 1: Open Source Documentation

• README.md: Project overview and simple interest logic.
• LICENSE: Full Apache License 2.0.
• CODE_OF_CONDUCT.md: Contributor Covenant standards.
• CONTRIBUTING.md: Guidelines for new contributors.
• simple-interest.sh: The core Bash script for interest calculation.

Part 2: Git CLI Submission Files

• forked-repo: Contains the forked repository verification (Task 6).
• merge_branches: Terminal output of the first merge operation.
• bug-fix-revert: Pull Request verification via GitHub API.
• github-branches: Complete branch status and metadata.

How to Run

• Bash: Run bash simple-interest.sh in your terminal.
• Web UI: Navigate the interactive React dashboard to calculate interests visually.