WorkFolio is a powerful and intuitive web application designed to streamline employee data management for organizations. The application provides a user-friendly interface to perform various CRUD (Create, Read, Update, Delete) operations on employee records. Built using Java, Spring Boot, Thymeleaf, and Bootstrap, WorkFolio offers a robust and efficient solution for managing employee data. π
- π Introduction
- β¨ Features
- βοΈ Prerequisites
- π οΈ Installation
- π― Usage
- π Technologies Used
- π€ Contributing
WorkFolio aims to simplify the process of managing employee information for businesses of all sizes. It provides a comprehensive and user-friendly platform to add, view, update, and delete employee records with ease. The application empowers HR departments and administrators to maintain accurate and up-to-date employee data, enhancing organizational efficiency. ππΌ
- β Add New Employee: Easily add new employees to the system with essential details, including name, email, phone, address, and salary.
- π View Employee Records: Browse through a paginated table to view all employee records, making it convenient to access and manage the information.
- π Update Employee Details: Effortlessly update employee information, such as name, email, phone, address, and salary, whenever required.
- β Delete Employee Records: Remove employee data from the system when needed, ensuring data accuracy and compliance with privacy regulations.
- βοΈ Input Validation: Implement strict input validation to ensure correct and consistent data entry, preventing errors and data discrepancies.
- π± Responsive Design: Enjoy a seamless user experience on various devices, thanks to the application's responsive design.
Before running the WorkFolio application, make sure you have the following prerequisites in place:
- β Java Development Kit (JDK): Version 8 or higher installed on your system.
- π§° Maven: Ensure you have the Maven build tool installed to compile and manage the project.
- ποΈ MySQL Database: Have a MySQL database set up and running to store employee data.
- π Web Browser: Use any modern web browser to access the application.
For detailed information on the classes, methods, and usage of the WorkFolio application, you can refer to the JavaDoc documentation.
The JavaDoc provides comprehensive documentation for the codebase, making it easier for developers to understand the functionality and use the APIs effectively.
Feel free to explore the JavaDoc website to gain insights into the application's architecture and explore the various features and functionalities it offers. If you have any questions or need further clarifications, the JavaDoc can be a valuable resource for you.
For a detailed demonstration of the project, technologies used, and its benefits, check out the video presentation on YouTube.
πΉ WorkFolio Video Presentation
Enjoy the demo, and I hope WorkFolio proves valuable in understanding the project and its technology stack. Thank you for watching! π
-
Clone the Repository: Begin by cloning the WorkFolio repository to your local machine using Git:
git clone https://github.com/Shubh2-0/WorkFolio.git
-
Navigate to the Project Directory: Move into the project directory using the following command:
cd workfolio
-
Build the Project: Use Maven to build the project and handle dependencies:
mvn clean package
-
Configure the Database Connection: Update the database connection details in the
application.properties
file:spring.datasource.url=jdbc:mysql://localhost:3306/workfolio spring.datasource.username=your-mysql-username spring.datasource.password=your-mysql-password
-
Run the Application: Start the WorkFolio application using Maven:
mvn spring-boot:run
- Access the Application: Open your web browser and navigate to
http://localhost:8080
to access the WorkFolio application. - Home Page: The homepage displays a paginated table containing all employee records.
- Add New Employee: Click on "Add New Employee" in the navigation menu to create a new employee record by providing relevant details.
- Edit Employee Details: To modify an existing employee's information, click the "Edit" button next to the employee's entry in the table and update the necessary fields.
- Delete Employee Records: To remove an employee's data from the system, click the "Delete" button next to the employee's entry in the table.
WorkFolio leverages a range of technologies to provide a seamless user experience and efficient management of employee data:
By leveraging this specific tech stack, WorkFolio achieves its goal of providing a seamless user experience and efficient management of employee data while maintaining a secure and reliable application environment. ππ
Contributions to WorkFolio are highly welcome! If you encounter any issues or have suggestions for improvements, feel free to create a new issue or submit a pull request. Together, we can enhance the application and make it even better. π¨βπ»π©βπ»
If you want to contact me, you can reach me through below handles.