{"id":23116316,"url":"https://github.com/nabilshadman/java-api-employee-reporting-tool","last_synced_at":"2025-08-16T21:07:46.559Z","repository":{"id":176914070,"uuid":"377777747","full_name":"nabilshadman/java-api-employee-reporting-tool","owner":"nabilshadman","description":"Java command-line tool for employee data management and salary report generation, featuring data validation and CSV output","archived":false,"fork":false,"pushed_at":"2024-12-05T13:01:14.000Z","size":849,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-09T13:13:01.258Z","etag":null,"topics":["api","csv-files","data-management","java","java-api","java-development","reporting-tool","software-development"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nabilshadman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-06-17T09:36:26.000Z","updated_at":"2024-12-05T13:01:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"359fc6f8-1997-4266-bf0d-bad05e54d844","html_url":"https://github.com/nabilshadman/java-api-employee-reporting-tool","commit_stats":null,"previous_names":["nabilshadman/java-api-employee-reporting-tool"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nabilshadman%2Fjava-api-employee-reporting-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nabilshadman%2Fjava-api-employee-reporting-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nabilshadman%2Fjava-api-employee-reporting-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nabilshadman%2Fjava-api-employee-reporting-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nabilshadman","download_url":"https://codeload.github.com/nabilshadman/java-api-employee-reporting-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247105347,"owners_count":20884421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","csv-files","data-management","java","java-api","java-development","reporting-tool","software-development"],"created_at":"2024-12-17T04:15:58.954Z","updated_at":"2025-04-04T01:25:40.417Z","avatar_url":"https://github.com/nabilshadman.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Employee Reporting Tool - Java API\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=flat\u0026logo=openjdk\u0026logoColor=white)\n![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)\n\nA lightweight Java application for managing employee data and generating salary reports. The tool provides employee record management with data validation and CSV report generation capabilities.\n\n## Table of Contents\n- [Features](#features)\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Demo](#demo)\n- [Architecture](#architecture)\n- [API Documentation](#api-documentation)\n- [Contributing](#contributing)\n- [Testing](#testing)\n- [License](#license)\n- [Citation](#citation)\n- [Acknowledgments](#acknowledgments)\n\n## Features\n- Employee record management with validation\n- Custom exception handling for numerical inputs\n- Automated CSV report generation\n- Interactive command-line interface\n- Data validation and sanitization\n- Configurable salary calculation\n\n## Requirements\n- Java Development Kit (JDK) 8 or later\n- Java Runtime Environment (JRE)\n- Terminal or Command Prompt\n- 256MB RAM minimum\n- 10MB disk space\n\n## Installation\n\n### From Source\n```bash\n# Clone the repository\ngit clone https://github.com/nabilshadman/java-api-employee-reporting-tool.git\n\n# Navigate to project directory\ncd java-api-employee-reporting-tool\n\n# Compile the project\njavac EmployeeReport/src/*.java -d EmployeeReport/bin\n```\n\n## Usage\n\n### Command Line Interface\n```bash\n# Run the application\njava -cp EmployeeReport/bin Driver\n```\n\n### Sample Input/Output\n```\nHow many employees are there? Please enter a number: 2\n\nPlease enter employee 1's data below.\nName: John\nHourly salary (number): 20.5\nHours worked (number): 40\n\nPlease enter employee 2's data below.\nName: Jane\nHourly salary (number): 25.0\nHours worked (number): 35\n```\n\nThe application generates `salary_report_employee.csv` with the following format:\n```csv\nEmployee Name,Salary,Hours,Weekly Pay\nJohn,20.50,40,820.00\nJane,25.00,35,875.00\n```\n\n## Demo\n\nHere's a visual demonstration of the application in action:\n\n\u003ctable\u003e\n\u003ctr\u003e\n  \u003ctd width=\"50%\"\u003e\n    \u003cimg src=\"./demo/0_employee_report_user_input.jpg\" width=\"400\" alt=\"Command Line Interface Input\"/\u003e\u003cbr/\u003e\n    \u003cem\u003e1. Interactive CLI collecting employee data\u003c/em\u003e\n  \u003c/td\u003e\n  \u003ctd width=\"50%\"\u003e\n    \u003cimg src=\"./demo/1_employee_report_csv_output.jpg\" width=\"400\" alt=\"Generated CSV Report\"/\u003e\u003cbr/\u003e\n    \u003cem\u003e2. Generated CSV salary report output\u003c/em\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\nThe tool features:\n- User-friendly command-line interface for data entry\n- Input validation for numerical values\n- Automated CSV report generation with formatted salary calculations\n\n\n## Architecture\nThe project follows a modular architecture with three main components:\n- `Employee.java`: Core data model and business logic\n- `Driver.java`: Main application entry point and UI\n- `InvalidNumberException.java`: Custom exception handling\n\n## API Documentation\nJavaDoc documentation is available in the `/EmployeeReport/doc` directory. Key classes:\n\n```java\npublic class Employee {\n    public Employee(String name, double hourlySalary, int hoursWorked)\n    public static void printSalaryReport(ArrayList\u003cEmployee\u003e employees)\n}\n```\n\n## Contributing\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit changes (`git commit -m 'Add AmazingFeature'`)\n4. Push to branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n## Testing\n```bash\n# Run test suite\njava -cp EmployeeReport/bin Test\n```\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details.\n\n## Citation\nIf you use this project in your research, please cite it as:\n```bibtex\n@software{java-api-employee-reporting,\n  author = {Shadman, Nabil},\n  title = {Employee Reporting Tool - Java API},\n  year = {2020},\n  publisher = {GitHub},\n  url = {https://github.com/nabilshadman/java-api-employee-reporting-tool}\n}\n```\n\n## Acknowledgments\n- OpenJDK community for Java development tools\n- Contributors and maintainers\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnabilshadman%2Fjava-api-employee-reporting-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnabilshadman%2Fjava-api-employee-reporting-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnabilshadman%2Fjava-api-employee-reporting-tool/lists"}