https://github.com/khanhduzz/employee-management

Spring MVC - Employee Management
https://github.com/khanhduzz/employee-management

Last synced: about 1 month ago
JSON representation

Spring MVC - Employee Management

• Host: GitHub
• URL: https://github.com/khanhduzz/employee-management
• Owner: khanhduzz
• License: mit
• Created: 2024-07-27T08:17:06.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-11T16:57:26.000Z (about 1 month ago)
• Last Synced: 2024-10-12T02:17:23.088Z (about 1 month ago)
• Language: Java
• Homepage:
• Size: 128 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Employee Management System

## Overview

This project is an Employee Management System built using Spring MVC, Thymeleaf, Spring Security, and Maven. It manages employee information and their associated accounts.

## ER Model



## Use cases



## Key Features

- Employee management (CRUD operations, Pagination and Filter)

- Account management (Linked to employee)

- User authentication and authorization using Spring Security

- User-friendly interface built with Thymeleaf

## Technology Stack

- **Spring MVC**: [Spring MVC](https://spring.io/projects/spring-mvc)

- **Thymeleaf**: [Thymeleaf](https://www.thymeleaf.org/)

- **Spring Security**: [Spring Security](https://spring.io/projects/spring-security)

- **Maven**: [Apache Maven](https://maven.apache.org/)

- **H2 database**: [H2 Database](https://www.h2database.com/html/main.html)

- **CI/CD with GitHub Actions**: [GitHub Actions](https://github.com/features/actions)

- **Docker image and DockerHub**: [Docker Hub](https://hub.docker.com/)

## Project Structure

- **src/main/java**: Contains Java source code for controllers, services, repositories, entities, and other components.

- **src/main/resources**: Contains configuration files (application.properties or application.yml), templates (Thymeleaf), and other resources.

- .github/workflows: Contains configuration files for GitHub pipelines and ci-cd

## Database Setup

1. Create a database with the specified name and schema.

2. Create tables for Employee and Account entities according to your database schema.

3. Configure database connection details in application.yml.

4. Configure variable in .env file

## Running the Application

1. Clone the repository.

2. Adding a new .env file to the project folder, then configure the information base on the .env sample

3. Build the project using Maven: `mvn clean install`

4. Run the application as a Spring Boot application.

## Dependencies

Specify necessary dependencies in the `pom.xml` file, including Spring MVC, Thymeleaf, Spring Security, database driver, and other required libraries.

## Security Configuration

- Configure requests and authorization in Spring Security configuration.

- Implement authentication and authorization logic.

## CI-CD

- Pipeline for check maven build project: merge on main

- Pipeline for build docker image and push to DockerHub: merge to ci-cd branch

## Contributing

If you want to contribute to this project, please fork the repository and submit a pull request.

## License

MIT license

## Contact

Provide contact information for project inquiries or support.

---