Skip to content

rookiyama/watracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

42 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ’§ WaTracker

A lightweight Water Station Finance & Inventory Manager.

WaTracker is a desktop application designed to streamline operations for local water refilling stations. It allows business owners to maintain a digital directory of customers, process daily transactions with support for various container types (Round/Slim) and water variants (Mineral/Purified/Alkaline), and view detailed sales history logs. The application utilizes a local SQLite database for zero-configuration data persistence.

This project was developed as a final requirement for the Object-Oriented Programming (OOP) course by students from BSCS 2-4.

Tech Stack:

  • Language: Java 17
  • Frontend: JavaFX
  • Database: SQLite
  • Build Tool: Maven

πŸ“₯ Releases

How to Download & Run: You do not need to install VS Code to use the application.

  1. Go to the Releases page of this repository.
  2. Download the latest WaTracker.jar file.
  3. Run the application:
    • Windows: Double-click the file (if Java is associated) or run via command prompt.
    • Linux/Mac: Open your terminal in the download folder and run:
    java -jar WaTracker.jar

Note: On the first launch, the app will automatically create a waterstation.db file in the same folder. Please keep this file safe as it contains all your customer data.


πŸ› οΈ Development

How to Setup and Compile: If you wish to modify the source code or build it yourself, follow these steps.

Prerequisites:

How to Run (VS Code):

  1. Clone the repository:
    git clone [https://github.com/rookiyama/watracker.git](https://github.com/rookiyama/watracker.git)
  2. Open the folder in VS Code and wait for the "Importing Maven project" status to finish.
  3. Do not use the standard Run button. Instead:
    • Open the Maven Sidebar in VS Code.
    • Go to watracker > Plugins > javafx.
    • Right-click javafx:run and select Run.

❓ Troubleshooting

Issue Solution
"Maven executable not found" Ensure the Extension Pack for Java is enabled in VS Code. You may need to restart the editor.
"JavaFX runtime components are missing" This occurs if you run App.java directly using the Play button. Please use the Maven sidebar (javafx:run) instructions above.
App won't close / Ghost process If the window closes but the terminal remains active, click the Trash Can icon (Kill Terminal) in the VS Code panel.

πŸ“‹ License

Distributed under the MIT License.

MIT License

Copyright (c) 2024 WaTracker

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

Finals Project for the Course "Object-Oriented Programming"

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors