To run the Income Breakdown Calculator, you have two options:

  1. Follow the installation and usage process described below.
  2. 🔗 Alternatively, you can directly access the web application here!.

Installation

To get started with this project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/alphiree/income-breakdown-calculator.git

  2. Navigate to the project directory:

    cd <path to the repository>

  3. Create a Python virtual environment (optional but recommended):

    python3 -m venv venv

  4. Activate the virtual environment:

    • On Windows:
      venv\Scripts\activate
    • On macOS and Linux:
      source venv/bin/activate

  5. Install the required packages using pip:

    pip install -r requirements.txt

  6. You’re all set! You can now start using the project.

Usage

To run the web application:

streamlit run main.py

Contributing

I welcome contributions to the Income Breakdown Calculator project! If you would like to contribute, please follow these steps:

  1. Fork the repository by clicking on the “Fork” button at the top right corner of the repository page.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/income-breakdown-calculator.git

  3. Create a new branch for your contribution:

    git checkout -b feature/your-contribution

  4. Make your changes and commit them:

    git commit -m "Add your contribution"

  5. Push your changes to your forked repository:

    git push origin feature/your-contribution

  6. Open a pull request on the original repository. Provide a clear and descriptive title and description for your contribution.

  7. Wait for the project maintainers to review your pull request. They may provide feedback or request changes.

  8. Once your pull request is approved, your contribution will be merged into the main project.

Thank you for contributing to the Income Breakdown Calculator project!