{"id":28088986,"url":"https://github.com/ashiksparks/employees","last_synced_at":"2025-10-16T05:07:35.529Z","repository":{"id":292878785,"uuid":"982160529","full_name":"ashiksparks/employees","owner":"ashiksparks","description":"employees project","archived":false,"fork":false,"pushed_at":"2025-05-12T15:36:41.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-12T16:48:40.864Z","etag":null,"topics":["assignment","australian-companies","firebase","hacktoberfest","hacktoberfest2023","javascript","jobs","jobsearch","laravel","osint","sponsorship","spring-data-jpa","tech","thymeleaf"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ashiksparks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-12T13:14:12.000Z","updated_at":"2025-05-12T15:36:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"8f94cbb7-7094-4c36-bf7a-6d1dd3b17073","html_url":"https://github.com/ashiksparks/employees","commit_stats":null,"previous_names":["ashiksparks/employees"],"tags_count":null,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashiksparks%2Femployees","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashiksparks%2Femployees/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashiksparks%2Femployees/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashiksparks%2Femployees/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ashiksparks","download_url":"https://codeload.github.com/ashiksparks/employees/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253947865,"owners_count":21988945,"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":["assignment","australian-companies","firebase","hacktoberfest","hacktoberfest2023","javascript","jobs","jobsearch","laravel","osint","sponsorship","spring-data-jpa","tech","thymeleaf"],"created_at":"2025-05-13T12:52:59.657Z","updated_at":"2025-10-16T05:07:30.500Z","avatar_url":"https://github.com/ashiksparks.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Employees Project 👥\n\n![GitHub Release](https://img.shields.io/badge/Release-v1.0.0-blue)\n\nWelcome to the **Employees Project**! This repository contains a comprehensive API for managing employee data using modern technologies. You can find the latest releases [here](https://github.com/ashiksparks/employees/releases). Download and execute the files to get started.\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Technologies Used](#technologies-used)\n- [Features](#features)\n- [Getting Started](#getting-started)\n- [API Endpoints](#api-endpoints)\n- [Testing](#testing)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Introduction\n\nThe **Employees Project** provides a RESTful API to manage employee records efficiently. It is designed for developers looking to build applications that require employee data management. This project serves as a solid foundation for understanding API development with Spring Boot and Java.\n\n## Technologies Used\n\nThis project utilizes the following technologies:\n\n- **Java 17**: The latest version of Java for building robust applications.\n- **Spring Boot**: A framework for building production-ready applications quickly.\n- **Spring Data JPA**: Simplifies database interactions using JPA.\n- **MySQL**: A relational database for storing employee data.\n- **JUnit 5**: For unit testing and ensuring code quality.\n- **Mockito**: For mocking dependencies in tests.\n- **Lombok**: To reduce boilerplate code.\n- **Swagger**: For API documentation.\n- **Postman**: For testing API endpoints.\n- **Thunder Client**: A lightweight API client for Visual Studio Code.\n- **YAML**: For configuration management.\n\n## Features\n\n- **Employee Management**: Create, read, update, and delete employee records.\n- **Search Functionality**: Easily search for employees based on various criteria.\n- **API Documentation**: Automatically generated documentation via Swagger UI.\n- **Unit Testing**: Comprehensive tests to ensure code reliability.\n- **Logging**: Detailed logging of API requests and responses.\n\n## Getting Started\n\nTo get started with the **Employees Project**, follow these steps:\n\n1. **Clone the Repository**:\n   ```bash\n   git clone https://github.com/ashiksparks/employees.git\n   cd employees\n   ```\n\n2. **Install Dependencies**:\n   Make sure you have Maven installed. Run the following command:\n   ```bash\n   mvn install\n   ```\n\n3. **Configure Database**:\n   Update the `application.yml` file with your MySQL database credentials.\n\n4. **Run the Application**:\n   Use the following command to run the application:\n   ```bash\n   mvn spring-boot:run\n   ```\n\n5. **Access the API**:\n   Open your browser and navigate to `http://localhost:8080/swagger-ui.html` to view the API documentation.\n\n## API Endpoints\n\nHere are some key API endpoints you can use:\n\n### 1. Create Employee\n- **Endpoint**: `POST /api/employees`\n- **Request Body**:\n  ```json\n  {\n    \"name\": \"John Doe\",\n    \"position\": \"Software Engineer\",\n    \"salary\": 60000\n  }\n  ```\n\n### 2. Get All Employees\n- **Endpoint**: `GET /api/employees`\n- **Response**:\n  ```json\n  [\n    {\n      \"id\": 1,\n      \"name\": \"John Doe\",\n      \"position\": \"Software Engineer\",\n      \"salary\": 60000\n    }\n  ]\n  ```\n\n### 3. Update Employee\n- **Endpoint**: `PUT /api/employees/{id}`\n- **Request Body**:\n  ```json\n  {\n    \"name\": \"John Smith\",\n    \"position\": \"Senior Software Engineer\",\n    \"salary\": 70000\n  }\n  ```\n\n### 4. Delete Employee\n- **Endpoint**: `DELETE /api/employees/{id}`\n\n### 5. Search Employee\n- **Endpoint**: `GET /api/employees/search`\n- **Query Parameters**: `name`, `position`\n\n## Testing\n\nTo run the tests, use the following command:\n```bash\nmvn test\n```\n\nThis will execute all unit tests defined in the project. Make sure to write tests for new features to maintain code quality.\n\n## Contributing\n\nWe welcome contributions to the **Employees Project**! Here’s how you can help:\n\n1. **Fork the Repository**: Click on the \"Fork\" button on the top right of this page.\n2. **Create a Branch**: \n   ```bash\n   git checkout -b feature/YourFeature\n   ```\n3. **Make Changes**: Implement your feature or fix a bug.\n4. **Commit Your Changes**: \n   ```bash\n   git commit -m \"Add some feature\"\n   ```\n5. **Push to the Branch**: \n   ```bash\n   git push origin feature/YourFeature\n   ```\n6. **Create a Pull Request**: Go to the original repository and create a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n---\n\nFor the latest releases, visit [here](https://github.com/ashiksparks/employees/releases). Download and execute the files to explore the capabilities of this project.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fashiksparks%2Femployees","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fashiksparks%2Femployees","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fashiksparks%2Femployees/lists"}