Skip to content

SmartSpend v1.0 - Initial Release

Latest
Latest

Choose a tag to compare

View all tags
@Arpitha-P-Ajay Arpitha-P-Ajay released this 04 Oct 09:45
· 2 commits to main since this release
v1.0
533bbc8
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

SmartSpend Budget Tracker - v1.0 Initial Release

This marks the first stable release of the SmartSpend Budget Tracker. This desktop application helps users manage personal finances by tracking income and expenses, and provides an option to send a financial summary via email.

Download & Run (For End-Users)

This is the easiest way to use the application if you already have Java installed.

  1. Download the Executable JAR:
    • Download SmartSpend-1.0-SNAPSHOT.jar from the "Assets" section below.
  2. Run the Application:
    • Open your terminal or command prompt.
    • Navigate to the directory where you downloaded the JAR file.
    • Execute the command: 
      java -jar SmartSpend-1.0-SNAPSHOT.jar
    • (Requires Java Development Kit (JDK) or Java Runtime Environment (JRE) version 21 or higher.)

Configure Email Reports (Mandatory for Email Functionality)

To enable the "Email Report" feature, you need to set up your own Gmail account for sending.

  1. Enable 2-Step Verification on your Google Account:
  2. Generate an "App Password":
    • Go to myaccount.google.com/apppasswords.
    • Follow the instructions to create a new App Password (e.g., name it "SmartSpend App"). Google will provide a 16-character password. Copy this password.
  3. Create config.properties:
    • In the same directory where you placed the SmartSpend-1.0-SNAPSHOT.jar file, create a new text file named config.properties.
  4. Add Your Credentials:
    • Open config.properties and add your Gmail address and the 16-character App Password: 
      EMAIL_USER=your.email@gmail.com
EMAIL_PASS=your16characterapppassword
      (Important: Replace your.email@gmail.com with your actual Gmail address and your16characterapppassword with the unique 16-character App Password generated by Google.)

Building from Source (For Developers)

If you wish to build the application from its source code, follow these steps.

Prerequisites

  • Java Development Kit (JDK): Version 21 or later.
  • Apache Maven: Version 3.6 or later.
  • Git: For cloning the repository.

Steps

  1. Clone the repository: 
    git clone https://github.com/Arpitha-P-Ajay/SmartSpend.git
  2. Open in IDE: Open the project in a Java IDE (VS Code, IntelliJ IDEA, Eclipse). The IDE will handle dependency downloads via Maven.
  3. Configure Email (for local development/testing):
    • Navigate to src/main/resources/.
    • Create config.properties and add your EMAIL_USER and EMAIL_PASS (as described in the "Configure Email Reports" section above). This file is ignored by Git.
  4. Build the Project:
    • Open a terminal in the project's root directory and run: 
      mvn clean install
  5. Run from IDE: Execute the main method in src/main/java/com/smartspend/App.java to start the application.
Assets 3
Loading