Employee-Management-Fullstack-App

KO | EN

gitlite — search

#python #android #react #machine-learning #javascript #nodejs #java #php #kotlin #covid-19 #awesome #python3

Employee-Management-Fullstack-App

★ 76 Open GitHub ↗

🧑🏻‍💻 This repository hosts the Employee Management Full-Stack App, built with a modern React frontend and a robust Java Spring Boot + Hibernate backend to provide efficient data management and an interactive & fully responsive user experience. Also provides JWT + WebAuthn passkeys for enhanced data security & protection.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Employee Management Full-Stack Application

The **Employee Management Full-Stack Application** is a modern, feature-rich system for managing employee and department data, built to demonstrate the power of combining traditional enterprise technologies with modern web frameworks. It leverages a responsive React frontend alongside a robust Spring Boot backend, delivering a seamless user experience with features such as CRUD operations, data visualization, authentication, and secure REST APIs.

Designed with scalability and maintainability in mind, this application is also fully containerized with Docker, orchestrated with Kubernetes, and supports CI/CD pipelines & blue/green and canary deployment techniques through Jenkins, making it an ideal blueprint for real-world enterprise applications.

## Table of Contents

- [Overview](#overview)
- [Architecture at a Glance](#architecture-at-a-glance)
  - [System Context](#system-context)
  - [Request Lifecycle](#request-lifecycle)
  - [DevOps Toolchain](#devops-toolchain)
- [Live Deployment](#live-deployment)
- [Key Technologies](#key-technologies)
- [User Interface](#user-interface)
- [API Endpoints](#api-endpoints)
- [File Structure](#file-structure)
- [Architecture Reference](#architecture-reference)
- [Backend Setup](#backend-setup)
  - [Prerequisites](#1-prerequisites)
  - [Clone the Repository](#2-clone-the-repository)
  - [Install Dependencies](#3-install-dependencies)
  - [Configure the Application](#4-configure-the-application)
  - [Start the Backend Server](#5-start-the-backend-server)
  - [Access the API Endpoints](#6-access-the-api-endpoints)
  - [API Documentation](#7-api-documentation)
    - [Overview](#overview-1)
    - [How to Access the API Documentation](#how-to-access-the-api-documentation)
    - [Benefits of Using Swagger UI](#benefits-of-using-swagger-ui)
  - [Backend JUnit Testing](#8-backend-junit-testing)
- [Frontend Setup](#frontend-setup)
  - [Clone the Repository](#1-clone-the-repository)
  - [Install Dependencies](#2-install-dependencies)
  - [Set Up Environment Variables](#3-set-up-environment-variables)
  - [Start the Development Server](#4-start-the-development-server)
  - [Build for Production](#5-build-for-production)
  - [Test the Application (Optional)](#6-test-the-application-optional)
- [Detailed Component Instructions](#detailed-component-instructions)
- [Containerization](#containerization)
- [Kubernetes](#kubernetes)
- [AWS Production Deployment](#aws-production-deployment)
- [LoadBalancer Service](#loadbalancer-service)
- [Jenkins](#jenkins)
- [OpenAPI Specification](#openapi-specification)
  - [Using the `openapi.yaml` File](#using-the-openapiyaml-file)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Overview

The Employee Management System is a dynamic full-stack application that seamlessly combines cutting-edge and traditional technologies. By integrating a modern **React** frontend with a classic **Spring Boot** backend, this project demonstrates how new and established technologies can harmoniously work together to create a robust and efficient application for managing employee and department data!

![Java](https://img.shields.io/badge/Java-007396?style=for-the-badge&logo=openjdk&logoColor=white)
![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)
![React](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=black)
![React Router](https://img.shields.io/badge/React%20Router-CA4245?style=for-the-badge&logo=reactrouter&logoColor=white)
![Redux](https://img.shields.io/badge/Redux-764ABC?style=for-the-badge&logo=redux&logoColor=white)
![Three.js](https://img.shields.io/badge/Three.js-000000?style=for-the-badge&logo=threedotjs&logoColor=white)
![React Three Fiber](https://img.shields.io/badge/React%20Three%20Fiber-000000?style=for-the-badge&logo=reactos&logoColor=61DAFB)
![WebGL](https://img.shields.io/badge/WebGL-444444?style=for-the-badge&logo=webgl&logoColor=white)
![Axios](https://img.shields.io/badge/Axios-5A29E4?style=for-the-badge&logo=axios&logoColor=white)
![Tailwind CSS](https://img.shields.io/badge/TailwindCSS-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white)
![Chart.js](https://img.shields.io/badge/Chart.js-FF6384?style=for-the-badge&logo=chartdotjs&logoColor=white)
![Jest](https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white)
![React Testing Library](https://img.shields.io/badge/React%20Testing%20Library-E33332?style=for-the-badge&logo=testinglibrary&logoColor=white)
![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white)
![Material UI](https://img.shields.io/badge/Material%20UI-007FFF?style=for-the-badge&logo=mui&logoColor=white)
![Emotion](https://img.shields.io/badge/Emotion-DB7093?style=for-the-badge&logo=styledcomponents&logoColor=white)
![react-chartjs-2](https://img.shields.io/badge/react--chartjs--2-FF6384?style=for-the-badge&logo=chartdotjs&logoColor=white)
![Web Vitals](https://img.shields.io/badge/Web%20Vitals-4285F4?style=for-the-badge&logo=googlechrome&logoColor=white)
![Prettier](https://img.shields.io/badge/Prettier-F7B93E?style=for-the-badge&logo=prettier&logoColor=black)
![Spring Boot](https://img.shields.io/badge/Spring%20Boot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white)
![Spring Data JPA](https://img.shields.io/badge/Spring%20Data%20JPA-6DB33F?style=for-the-badge&logo=spring&logoColor=white)
![Hibernate](https://img.shields.io/badge/Hibernate-59666C?style=for-the-badge&logo=hibernate&logoColor=white)
![JUnit5](https://img.shields.io/badge/JUnit5-25A162?style=for-the-badge&logo=junit5&logoColor=white)
![Swagger](https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge&logo=swagger&logoColor=black)
![OpenAPI](https://img.shields.io/badge/OpenAPI-6BA539?style=for-the-badge&logo=openapiinitiative&logoColor=white)
![Bean Validation](https://img.shields.io/badge/Bean%20Validation-6DB33F?style=for-the-badge&logo=spring&logoColor=white)
![Lombok](https://img.shields.io/badge/Lombok-BC2C2B?style=for-the-badge&logo=lombok&logoColor=white)
![JavaFaker](https://img.shields.io/badge/JavaFaker-2E7D32?style=for-the-badge&logo=faker&logoColor=white)
![Spring Security](https://img.shields.io/badge/Spring%20Security-6DB33F?style=for-the-badge&logo=springsecurity&logoColor=white)
![WebAuthn](https://img.shields.io/badge/WebAuthn-3423A6?style=for-the-badge&logo=webauthn&logoColor=white)
![Passkeys](https://img.shields.io/badge/Passkeys-4285F4?style=for-the-badge&logo=passport&logoColor=white)
![FIDO2](https://img.shields.io/badge/FIDO2-ED1C24?style=for-the-badge&logo=fidoalliance&logoColor=white)
![Yubico WebAuthn](https://img.shields.io/badge/Yubico%20WebAuthn-84BD00?style=for-the-badge&logo=yubico&logoColor=black)
![JWT](https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=jsonwebtokens&logoColor=white)
![BCrypt](https://img.shields.io/badge/BCrypt-338033?style=for-the-badge&logo=letsencrypt&logoColor=white)
![MySQL](https://img.shields.io/badge/MySQL-4479A1?style=for-the-badge&logo=mysql&logoColor=white)
![MongoDB](https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white)
![H2 Database](https://img.shields.io/badge/H2%20Database-09476B?style=for-the-badge&logo=h2database&logoColor=white)
![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
![Kubernetes](https://img.shields.io/badge/Kubernetes-326CE5?style=for-the-badge&logo=kubernetes&logoColor=white)
![Jenkins](https://img.shields.io/badge/Jenkins-D24939?style=for-the-badge&logo=jenkins&logoColor=white)
![Nginx](https://img.shields.io/badge/Nginx-009639?style=for-the-badge&logo=nginx&logoColor=white)
![Render](https://img.shields.io/badge/Render-000000?style=for-the-badge&logo=render&logoColor=white)
![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white)
![Maven](https://img.shields.io/badge/Maven-C71A36?style=for-the-badge&logo=apachemaven&logoColor=white)
![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)
![npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
![Airbnb JavaScript Style Guide](https://img.shields.io/badge/Airbnb%20Style-FF5A5F?style=for-the-badge&logo=airbnb&logoColor=white)
![Google Java Style Guide](https://img.shields.io/badge/Google%20Java%20Style-4285F4?style=for-the-badge&logo=google&logoColor=white)
![IntelliJ IDEA](https://img.shields.io/badge/IntelliJ%20IDEA-000000?style=for-the-badge&logo=intellijidea&logoColor=white)
![WebStorm](https://img.shields.io/badge/WebStorm-000000?style=for-the-badge&logo=webstorm&logoColor=white)
![Git](https://img.shields.io/badge/Git-F05032?style=for-the-badge&logo=git&logoColor=white)
![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white)

## Architecture at a Glance

- React SPA (Material UI, Tailwind CSS, Chart.js) consumes the Spring Boot REST API over HTTPS via Axios.
- Spring Boot layers (controller → service → repository) persist to MySQL through Spring Data JPA and seed demo data with Faker-powered `DataInitializer`.
- Production-ready deployment with Docker containers, Kubernetes orchestration (blue-green & canary strategies), Terraform infrastructure-as-code, and comprehensive Jenkins CI/CD pipeline with automated testing, security scanning, and multi-strategy deployments.

### System Context

```mermaid
flowchart LR
    User([End User]) -->|HTTPS| UI[React SPA\nTailwind + Material UI + Axios + Chart.js]
    UI -->|REST / JSON| API[Spring Boot REST API\nControllers & Services]
    API -->|Spring Data JPA| MySQL[(MySQL Schema\n`departments`, `employees`, `users`)]
    API -->|Optional Spring Data Mongo| Mongo[(MongoDB Cluster)]
    API -->|OpenAPI 3.0| Swagger[Swagger UI]
    subgraph Runtime Options
        Compose[Docker Compose]
        K8s[Kubernetes Manifests]
    end
    Compose --> UI
    Compose --> API
    K8s --> UI
    K8s --> API
```

### Request Lifecycle

```mermaid
sequenceDiagram
    participant U as User
    participant UI as React Component
    participant C as EmployeeController
    participant S as EmployeeService
    participant R as EmployeeRepository
    participant DB as MySQL
    U->>UI: Trigger "Add Employee"
    UI->>C: POST /api/employees (EmployeeRequestDto)
    C->>C: Validate @Valid + resolve Department
    C->>S: saveEmployee(entity)
    S->>R: save(employee)
    R->>DB: INSERT row
    DB-->>R: persisted entity
    S->>S: flush + refresh (load department)
    S-->>C: Employee (with department)
    C->>C: convertToDto(employee)
    C-->>UI: 200 OK (EmployeeResponseDto)
```

### DevOps Toolchain

```mermaid
flowchart LR
    Dev[Git Changes]
    Jenkins[Jenkins Pipeline\n`npm install` + `npm run build`]
    Makefile[Makefile & scripts\nDocker/k8s helpers]
    Images[Docker Images\nfrontend & backend]
    Infra[Terraform AWS Stack\nEKS · RDS · ECR]
    Cluster[EKS/Kubernetes Deployment]

Dev --> Jenkins
    Jenkins -->|Build artifacts| Makefile
    Makefile --> Images
    Images --> Cluster
    Infra --> Cluster
```
## Live Deployment

The Employee Management System full-stack app is deployed with Vercel and is live at [https://employee-manage-app.vercel.app](https://employee-manage-app.vercel.app) for you to explore and interact with the application.

The backend is also deployed with Render and is available at [https://employee-management-app.onrender.com](https://employee-management-app-gdm5.onrender.com/). You can access the API endpoints directly from the browser at the root (`/`) endpoint as we've set up the Swagger UI documentation for easy testing.

> [!IMPORTANT]
> **Note:** The backend API may spin down due to inactivity, so you may need to wait for up to 2 minutes for the API to start up again. Feel free to test the API endpoints and explore the application. Or, you can run the backend locally and connect it to the frontend for a more seamless experience.

> [!NOTE]
> **Additional Note:** It may take a while to fetch the data and process your requests, as Render's free tier has VERY limited resources (only 512MB RAM and 0.1 CPU).

## Key Technologies

- **React (Frontend)**: A modern JavaScript library for building user interfaces, providing a responsive and interactive experience.
  - **React Router**: A routing library for React that enables navigation and URL handling in single-page applications.
  - **Chart.js**: A JavaScript library for creating responsive and customizable charts and graphs.
  - **React Three Fibers + Three.js + WebGL:** For 3D component stylings and appealing user experiences.
  - **Axios**: A promise-based HTTP client for making API requests.
  - **Tailwind CSS**: A utility-first CSS framework for creating custom designs with minimal CSS.
  - **Redux**: A predictable state container for managing application state.
  - **Jest and React Testing Library**: Testing libraries for unit and integration testing React components.
- **Java Spring Boot (Backend)**: A powerful, established Java framework for building production-ready applications with Java, offering robust backend support and data management.
  - **Spring Data JPA**: A part of the Spring Data project that makes it easy to implement JPA-based repositories.
  - **Spring Boot Actuator**: A set of production-ready features that help monitor and manage the application.
  - **Spring Hibernate**: An object-relational mapping (ORM) library for Java that provides a framework for mapping an object-oriented domain model to a relational database.
  - **Spring Boot Starter Web**: A starter for building web applications, including RESTful, application, and WebSocket services.
  - **Spring Boot Starter Data JPA**: A starter for using Spring Data JPA with Hibernate.
  - **RESTful APIs**: Representational state transfer (REST) APIs for communication between the frontend and backend.
  - **Java 11**: The latest LTS version of Java, providing long-term support and stability.
  - **JUnit 5**: A popular testing framework for Java that provides annotations for writing tests.
  - **Swagger**: A tool for documenting and testing RESTful APIs.
- **Docker**: A containerization platform for packaging applications and their dependencies.
- **Kubernetes**: An open-source container orchestration platform for automating deployment, scaling, and management of containerized applications.
- **Jenkins**: An open-source automation server that helps automate the parts of software development related to building, testing, and delivering, facilitating continuous integration and continuous delivery (CI/CD).
- **MySQL**: A reliable relational database for structured data storage.
- **MongoDB**: A flexible NoSQL database for non-relational data.
- **Style Guides**: This project follows the following popular style guides to ensure clean and consistent code.
  - **Airbnb JavaScript Style Guide**: A popular style guide for writing clean and consistent JavaScript code.
  - **Google Java Style Guide**: A style guide for writing Java code that is readable and maintainable.

## User Interface

The frontend of the Employee Management System provides a user-friendly interface for managing employees and departments. It includes features for viewing, adding, editing, and deleting employees and departments. The app also includes visualizations for employee metrics such as growth over time and distribution by age range.

The frontend is also live at [https://employee-manage-app.vercel.app](https://employee-manage-app.vercel.app) for you to explore and interact with the application. Note that the backend is not hosted, so the API calls will not work and the data will not be present.

**Landing Page:**

Polished with `Three.js` and React Three Fiber + WebGL for a great UX and an immersive 3D experience

**Dashboard Page:**

**Employee List Page:**

**Department List Page:**

**Profile Page:**

**Passkeys Management Page:**

**Login Page:**

**Register Page:**

**Reset Password Page:**

And many more features & pages to explore! Feel free to navigate through the application and test the various functionalities.

## API Endpoints

Here's a table listing all the RESTful API endpoints provided by this application:

| Endpoint                       | Method | Description                         | Request DTO              | Response DTO              |
|--------------------------------|--------|-------------------------------------|--------------------------|---------------------------|
| `/api/employees`               | GET    | Get all employees                   | -                        | `EmployeeResponseDto[]`   |
| `/api/employees/{id}`          | GET    | Get an employee by ID               | -                        | `EmployeeResponseDto`     |
| `/api/employees`               | POST   | Add a new employee                  | `EmployeeRequestDto`     | `EmployeeResponseDto`     |
| `/api/employees/{id}`          | PUT    | Update an employee by ID            | `EmployeeRequestDto`     | `EmployeeResponseDto`     |
| `/api/employees/{id}`          | DELETE | Delete an employee by ID            | -                        | 204 No Content            |
| `/api/departments`             | GET    | Get all departments                 | -                        | `DepartmentResponseDto[]` |
| `/api/departments/{id}`        | GET    | Get a department by ID              | -                        | `DepartmentResponseDto`   |
| `/api/departments`             | POST   | Add a new department                | `DepartmentRequestDto`   | `DepartmentResponseDto`   |
| `/api/departments/{id}`        | PUT    | Update a department by ID           | `DepartmentRequestDto`   | `DepartmentResponseDto`   |
| `/api/departments/{id}`        | DELETE | Delete a department by ID           | -                        | 204 / 409 Conflict        |
| `/register`                    | POST   | Register a new user                 | `AuthRequestDto`         | Success message           |
| `/authenticate`                | POST   | Authenticate and get JWT token      | `AuthRequestDto`         | `{ token }`               |
| `/verify-username/{username}`  | GET    | Check if a username exists          | -                        | Status message            |
| `/reset-password`              | POST   | Reset a user's password             | `ResetPasswordRequestDto`| Status message            |
| `/api/passkeys/register/start` | POST   | Start passkey registration (JWT)    | -                        | `{ flowId, options }`     |
| `/api/passkeys/register/finish`| POST   | Finish passkey registration (JWT)   | `{ flowId, credential, name }` | `PasskeyDto`        |
| `/api/passkeys`                | GET    | List my passkeys (JWT)              | -                        | `PasskeyDto[]`            |
| `/api/passkeys/{id}`           | PATCH  | Rename a passkey (JWT)              | `{ name }`               | `PasskeyDto`              |
| `/api/passkeys/{id}`           | DELETE | Delete a passkey (JWT)             | -                        | 204 No Content            |
| `/api/passkeys/authenticate/start` | POST | Start passkey login (public)     | `{ username? }`          | `{ flowId, options }`     |
| `/api/passkeys/authenticate/finish`| POST | Finish passkey login (public)    | `{ flowId, credential }` | `{ token, username }`     |
| `/swagger-ui.html`             | GET    | Access the Swagger UI documentation | -                        | -                         |

### DTO Reference

**`EmployeeRequestDto`** (create/update input):
```json
{ "firstName": "John", "lastName": "Doe", "email": "john@example.com", "age": 30, "department": { "id": 1 } }
```

**`EmployeeResponseDto`** (API output):
```json
{ "id": 1, "firstName": "John", "lastName": "Doe", "email": "john@example.com", "age": 30, "department": { "id": 1, "name": "Engineering" } }
```

**`DepartmentRequestDto`** (create/update input):
```json
{ "name": "Engineering" }
```

**`DepartmentResponseDto`** (API output):
```json
{ "id": 1, "name": "Engineering", "employeeCount": 12 }
```

## File Structure

```mermaid
%%{init: {'theme': 'base', 'themeVariables': {
  'background': '#ffffff',
  'primaryColor': '#f5f7ff',
  'primaryBorderColor': '#1E3C72',
  'primaryTextColor': '#0f172a',
  'secondaryColor': '#e0e7ff',
  'tertiaryColor': '#ffffff',
  'textColor': '#ffffff',
  'lineColor': '#1E3C72'
}}}%%
mindmap
  root((Employee-Management))
    ARCHITECTURE.md
    Jenkinsfile
    Makefile
    README.md
    docker-compose.yml
    openapi.yaml
    aws
      README.md
      terraform
        example.tfvars
        providers.tf
        locals.tf
        network.tf
        eks.tf
        rds.tf
        secrets.tf
        ecr.tf
        outputs.tf
        variables.tf
    backend
      Dockerfile
      pom.xml
      config.properties
      example_config.properties
      src
        main
          java/com/example/employeemanagement
            controller
            service
            repository
            model
            security
          resources/application.properties
        test/java/com/example/employeemanagement
    frontend
      Dockerfile
      package.json
      src/components
      src/services
    kubernetes
      backend-deployment.yaml
      backend-service.yaml
      configmap.yaml
      frontend-deployment.yaml
    terraform
      main.tf
      modules
        network
        eks
        rds
        ecr
      variables.tf
    scripts
      build-images.sh
      deploy-k8s.sh
      ...
    nginx
      Dockerfile
      nginx.conf
    img/*.png
    package.json
```

> [!TIP]
> Note: Generated directories such as `node_modules/`, `target/`, and `build/` are omitted for brevity.

## Architecture Reference

For a deeper dive into components, data flow, security posture, and recommended follow-up tasks, see [ARCHITECTURE.md](ARCHITECTURE.md). It cross-references the exact source files (controllers, services, repositories, configuration, tests, and infrastructure) described in this README.

## Backend Setup

### 1. Prerequisites

Ensure that you have Java 11 installed on your local machine. If not, follow the instructions below:

- For MacOS:
    ```bash
    brew install openjdk@11
    export JAVA_HOME=/usr/local/opt/openjdk@11
    ```

- For Windows: Download OpenJDK 11 from [https://jdk.java.net/archive/](https://jdk.java.net/archive/) and follow the installation instructions.

- Also, ensure that MongoDB and MySQL are installed and running on your local machine.

### 2. Clone the Repository

```bash
git clone https://github.com/hoangsonww/Employee-Management-Fullstack-App.git
cd Employee-Management-Fullstack-App  # Fix the paths if necessary
cd backend
```

### 3. Install Dependencies

First, ensure you have [Maven](https://maven.apache.org/) and [Java JDK](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html) installed. Run the following command to install them:

- For MacOS:
    ```bash
    brew install maven
    ```
- For Windows: Download Maven from [https://maven.apache.org/download.cgi](https://maven.apache.org/download.cgi) and follow the installation instructions.

Next, install the project dependencies:

```bash
mvn install
```

### 4. Configure the Application

The backend reads MySQL and MongoDB settings from variables loaded through `backend/config.properties`. Use values that match your local database:

```properties
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_DB=employee_management
MYSQL_USER=root
MYSQL_PASSWORD=password
MYSQL_SSL_MODE=DISABLED
MONGO_URI=mongodb://localhost:27017/employee_management

# JWT Secret (required - generate with: openssl rand -base64 32)
JWT_SECRET=your-secret-key-here

# Passkeys / WebAuthn — rp-id MUST match the domain the FRONTEND is served from (no scheme/port).
# Defaults target local development; set these for production.
WEBAUTHN_RP_ID=localhost
WEBAUTHN_RP_NAME=Employee Management System
WEBAUTHN_ALLOWED_ORIGINS=http://localhost:3000,http://localhost:8080
```

> **Passkeys in production:** set `WEBAUTHN_RP_ID` to the frontend's domain (e.g. `employee-manage-app.vercel.app`) and `WEBAUTHN_ALLOWED_ORIGINS` to the exact frontend origin(s) (e.g. `https://employee-manage-app.vercel.app`). WebAuthn requires HTTPS (localhost is exempt).

For MySQL bootstrap, you have two supported options:

1. Run the root [data.sql](data.sql) file for the all-in-one setup.
2. Run the split backend SQL scripts in order:
   `backend/sql/01_create_database.mysql.sql`,
   `backend/sql/02_create_tables.mysql.sql`,
   and optionally `backend/sql/03_performance_optimizations.mysql.sql`.

The split SQL workflow is documented in [backend/sql/README.md](backend/sql/README.md).

Important:

- The backend can auto-create missing tables in an existing blank database because `spring.jpa.hibernate.ddl-auto=update` is enabled.
- The backend does not auto-create the database itself if `MYSQL_DB` points to a database that does not exist yet.
- On first startup, `DataInitializer` seeds `departments` and `employees` if the tables are empty. It does not re-seed on subsequent startups.
- The `users` table is created by the schema, but user accounts are not auto-seeded.

### 5. Start the Backend Server

Before starting the server, ensure that:

- MySQL is running and `MYSQL_DB` points to an existing database
- MongoDB is running and `MONGO_URI` is valid
- you have either run the SQL bootstrap files or allowed Hibernate to create the tables in a blank existing MySQL database

Then, run the following command to start the Spring Boot application:

```bash
mvn spring-boot:run
```

The backend will be available at [http://localhost:8080](http://localhost:8080).

### 6. Access the API Endpoints

- **Get All Employees:**

```bash
  curl -X GET http://localhost:8080/api/employees
  ```

- **Get Employee by ID:**

```bash
  curl -X GET http://localhost:8080/api/employees/1
  ```

- **Get All Departments:**

```bash
  curl -X GET http://localhost:8080/api/departments
  ```

- **Get Department by ID:**

```bash
  curl -X GET http://localhost:8080/api/departments/1
  ```

- **Feel free to add more API endpoints as needed...**

```mermaid
flowchart TB
    A[Install Java 11 & Maven] --> B[Clone repository]
    B --> C[Configure backend/config.properties]
    C --> D[Create DB via data.sql or backend/sql scripts]
    D --> E[Start MySQL & MongoDB]
    E --> F[mvn spring-boot:run]
    F --> G[API reachable at http://localhost:8080]
```

### 7. API Documentation

#### Overview

This application also uses Swagger to provide an interactive API documentation interface. The Swagger UI allows developers to explore the available API endpoints, view detailed information about each endpoint, and test the endpoints directly from the browser.

#### How to Access the API Documentation

1. **Start the Backend Server**: Ensure that the backend server is running. You can start the server by navigating to the backend directory and running:

```bash
   mvn spring-boot:run
   ```

2. **Open the Swagger UI**: Once the server is up and running, you can access the Swagger UI by navigating to the following URL in your web browser:

[http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html)

This will open the Swagger interface where you can explore the API endpoints.

3. Alternatively, for those who need the raw OpenAPI JSON, it is available at:

[http://localhost:8080/v3/api-docs](http://localhost:8080/v3/api-docs)

4. **Explore the API Endpoints**:
- Use the sidebar or the search bar to navigate through the available API endpoints.
- Click on an endpoint to view its details, including the request method (GET, POST, PUT, DELETE), parameters, request body, and possible responses.
- You can also test the endpoints directly by clicking the **"Try it out"** button, providing the necessary input, and executing the request.
- If you have everything set up correctly, you should see the following Swagger UI interface:

#### Benefits of Using Swagger UI

- **Interactive Documentation**: Developers can easily understand and use the API.
- **Quick Testing**: Test the API endpoints directly from the browser without needing a separate tool.
- **Clear Communication**: Provides a standardized way of documenting your API, making it easier for others to understand and consume.

### 8. Backend JUnit Testing

To run the unit and integration tests, use:

```bash
mvn test
```

This will run the tests and provide you with the results. Ensure that all tests pass before making any changes to the application.

Feel free to add more tests as needed to ensure the reliability and correctness of your application.

## Frontend Setup

### 1. Clone the Repository

```bash
git clone https://github.com/hoangsonww/Employee-Management-Fullstack-App.git
cd Employee-Management-Fullstack-App  # Fix the paths if necessary
cd frontend
```

### 2. Install Dependencies

Ensure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed. Run the following command to install the required dependencies:

```bash
npm install
```

### 3. Set Up Environment Variables

Create a `.env` file in the root of your project if it doesn't already exist. Add the following environment variable:

```env
REACT_APP_API_URL=http://localhost:8080/api
```

### 4. Start the Development Server

Run the following command to start the React development server:

```bash
npm start
```

The frontend will be available at [http://localhost:3000](http://localhost:3000).

### 5. Build for Production

To create a production build of your application, run:

```bash
npm run build
```

The build files will be generated in the `build` directory. You can deploy these files to your production server.

### 6. Test the Application (Optional)

To run tests for the frontend application, use the following command:

```bash
npm test
```

The frontend uses **Jest** + **React Testing Library**. Alongside the behavioral suites, every screen has a **snapshot test** under `frontend/__tests__/snapshots/` (one file per screen — Landing, Login, Register, Reset Password, Verify Username, Dashboard, Employee List/Form, Department List/Form, New Department, Profile, Passkeys, Not Found, Quick Actions, Navbar, Footer). Each renders the component with the providers it needs (router, mocked services) and asserts the rendered markup with `toMatchSnapshot()`, so unintended UI changes surface as a diff. The snapshots are deterministic — the 3D hero and charts are stubbed, `autoFocus` is neutralized, `Date` is frozen where rendered, and data fetches are mocked — so they pass identically on local machines and CI regardless of timezone or run time.

```bash
# Run only the snapshot suites
npm test -- __tests__/snapshots

# Update the baselines after an intentional UI change, then commit the .snap files
npm test -- -u
```

**NOTE: You might need different IDEs for the backend and the frontend. FYI, I used IntelliJ IDEA for the backend and Webstorm for the frontend.**

## Detailed Component Instructions

### `Dashboard.js`

Displays various metrics related to employees, such as total employee count, average age, employee growth over time, and distribution by age range. It uses `react-chartjs-2` to render bar charts.

### `EmployeeList.js`

Shows a list of employees with options to search, paginate, and delete entries. Includes a link to add a new employee and edit existing employees.

### `EmployeeForm.js`

Provides a form for adding or editing employee details. Fetches departments to populate the department dropdown. Uses `useParams` to determine if it's in edit mode or add mode.

### `DepartmentList.js`

Displays a list of departments with options to search, paginate, and delete entries. Includes a link to add a new department and edit existing departments.

### `DepartmentForm.js`

Provides a form for adding or editing department details.

### `Navbar.js`

The navigation bar component that includes links to various pages such as Dashboard, Employees, and Departments. Highlights the currently active page.

## Containerization

If you'd also like to containerize the project, the project also includes the `dockerfile` and `docker-compose.yaml` files for containerization. You can build and run the application in a Docker container using the following command:

```bash
docker compose up --build
```

This command will build the Docker images for the frontend and backend, create containers, and start the application. Feel free to view them in Docker Desktop.

Alternatively, you can navigate to the `backend` and `frontend` directories and build the Docker images separately using the following commands:

```bash
docker build -t <your_docker_username>/employee-management-app-backend .
docker build -t <your_docker_username>/employee-management-app-frontend .
```

Then, you can run the containers using the following commands:

```bash
docker run -p 8080:8080 <your_docker_username>/employee-management-app-backend
docker run -p 3000:3000 <your_docker_username>/employee-management-app-frontend
```

Also, you can push the Docker images to Docker Hub using the following commands:

```bash
docker push <your_docker_username>/employee-management-app-backend
docker push <your_docker_username>/employee-management-app-frontend
```

Additionally, you can access the image on **Docker Hub** **[here](https://hub.docker.com/repository/docker/hoangsonw/employee-management-app/).**

## Kubernetes

The project includes production-ready Kubernetes manifests with support for advanced deployment strategies:

### Deployment Strategies

- **Rolling Deployment**: Gradual zero-downtime updates with automatic rollback
- **Blue-Green Deployment**: Complete environment switch for instant rollback capability
- **Canary Deployment**: Gradual traffic shift to validate new versions (10% → 100%)

### Production Features

- **High Availability**: 3 replicas per deployment with pod anti-affinity
- **Auto-Scaling**: Horizontal Pod Autoscaler based on CPU/memory metrics
- **Security**: Network policies, RBAC, non-root containers, secrets encryption
- **Observability**: Health probes, Prometheus metrics, CloudWatch integration
- **Resilience**: Pod Disruption Budgets, graceful shutdown, automatic rollback

### Quick Start

```bash
# Deploy using blue-green strategy
cd kubernetes
export ECR_REGISTRY=<your-ecr-url>
export IMAGE_TAG=v1.0.0

envsubst < backend-deployment-blue.yaml | kubectl apply -f -
envsubst < frontend-deployment-blue.yaml | kubectl apply -f -

# Or use deployment scripts
./scripts/deploy-blue-green.sh green v1.2.3
./scripts/switch-blue-green.sh green

# Canary deployment
./scripts/deploy-canary.sh v1.2.3
./scripts/promote-canary.sh v1.2.3
```

For comprehensive deployment instructions, see **[kubernetes/DEPLOYMENT-GUIDE.md](kubernetes/DEPLOYMENT-GUIDE.md)**.

## AWS Production Deployment

The `aws/terraform/` directory contains a comprehensive Terraform stack for production-grade AWS infrastructure:

### Infrastructure Components

- **Networking**: Multi-AZ VPC with public/private subnets, NAT gateways, and security groups
- **Compute**: Amazon EKS cluster with:
  - Production node group (ON_DEMAND instances)
  - Spot instance node group for cost optimization
  - Cluster Autoscaler for dynamic scaling
  - IMDSv2 enforcement for security
  - Encrypted EBS volumes
- **Data**: Amazon RDS MySQL with:
  - Multi-AZ deployment for high availability
  - Automated backups (14-day retention)
  - Encryption at rest with KMS
  - Secrets Manager integration
- **Registry**: Amazon ECR repositories with:
  - Image lifecycle policies
  - Vulnerability scanning
  - Immutable image tags
- **IAM & Security**:
  - IRSA (IAM Roles for Service Accounts) for pods
  - AWS Load Balancer Controller IAM role
  - Cluster Autoscaler IAM role
  - KMS encryption for EKS secrets
  - CloudWatch logging for control plane

### Production Enhancements

- **Cluster Encryption**: KMS-encrypted Kubernetes secrets
- **Control Plane Logging**: API, audit, authenticator, controller, scheduler logs
- **Service Accounts**: Pre-configured IAM roles for backend, load balancer controller, autoscaler
- **Node Groups**: Separate production and spot node groups with proper taints/labels
- **Monitoring**: CloudWatch Container Insights integration

### Deployment

As mentioned, we fully support blue/green and canary deployment strategies with the provided Kubernetes manifests and deployment scripts on top of the AWS infrastructure.

```bash
cd aws/terraform
terraform init
terraform plan
terraform apply

# Get cluster access
aws eks update-kubeconfig --region us-east-1 --name employee-management-eks
```

Follow the step-by-step instructions in [`aws/README.md`](aws/README.md) to apply the Terraform plan, push Docker images, surface database credentials as Kubernetes secrets, and roll out the workloads. For full deployment guide, refer to [kubernetes/DEPLOYMENT-GUIDE.md](kubernetes/DEPLOYMENT-GUIDE.md).

## LoadBalancer Service

The project also features Nginx as a LoadBalancer service for routing traffic to the frontend and backend services. The Nginx configuration file is located in the `nginx` directory.

There is also a `Dockerfile` for building the Nginx image. We are using this file to build the Nginx image and deploy it to the cloud with Render, which we are currently using to balance the traffic of the frontend and backend services.

Feel free to customize the Nginx configuration to suit your specific requirements and deployment process.

## Jenkins

The project includes a comprehensive CI/CD pipeline with support for multiple deployment strategies:

### Pipeline Features

- **Multi-Strategy Support**: Choose between Rolling, Blue-Green, or Canary deployments
- **Parallel Execution**: Backend and frontend builds run concurrently
- **Security Scanning**: Trivy vulnerability scanning for Docker images
- **Quality Checks**: Linting, testing, and code quality gates
- **Auto-Rollback**: Automatically rolls back failed deployments
- **Health Verification**: Post-deployment smoke tests and monitoring

### Pipeline Parameters

### Pipeline Stages

1. **Initialize**: Workspace setup and Git checkout
2. **Install Dependencies**: Parallel backend and frontend dependency installation
3. **Code Quality & Security**: Linting and security scans
4. **Run Tests**: JUnit (backend) and Jest (frontend) tests
5. **Build Applications**: Maven/npm build processes
6. **Build & Push Images**: Docker image creation and ECR push
7. **Image Security Scan**: Container vulnerability assessment
8. **Configure kubectl**: EKS cluster authentication
9. **Deploy**: Strategy-specific deployment (rolling/blue-green/canary)
10. **Post-Deployment Tests**: Smoke tests and health checks
11. **Monitor**: Deployment status verification

### Usage

Create a Jenkins pipeline job and point it to the `Jenkinsfile`. The pipeline will automatically detect deployment parameters and execute the appropriate strategy.

```mermaid
flowchart LR
    Commit[Git Commit] --> Jenkins[Jenkins Pipeline]
    Jenkins --> Install[Stage: Install Dependencies
`npm install`]
    Install --> BuildStage[Stage: Build
`npm run build`]
    BuildStage --> Artifacts[React build artifacts]
    Artifacts --> Docker[Stage: Build Docker Images
`docker build`]
    Docker --> Push[Stage: Push to Docker Hub
`docker push`]
    Push --> Deploy[Stage: Deploy to Kubernetes
`kubectl apply`]
    Deploy --> Cluster[Kubernetes Cluster]
```

## OpenAPI Specification

### Using the `openapi.yaml` File

1. **View the API Documentation**
- Open [Swagger Editor](https://editor.swagger.io/).
- Upload the `openapi.yaml` file or paste its content.
- Visualize and interact with the API documentation.

2. **Test the API**
- Import `openapi.yaml` into [Postman](https://www.postman.com/):
  - Open Postman → Import → Select `openapi.yaml`.
  - Test the API endpoints directly from Postman.
- Or use [Swagger UI](https://swagger.io/tools/swagger-ui/):
  - Provide the file URL or upload it to view and test endpoints.

3. **Generate Client Libraries**
- Install OpenAPI Generator:
 ```bash
 npm install @openapitools/openapi-generator-cli -g
 ```
- Generate a client library:
 ```bash
 openapi-generator-cli generate -i openapi.yaml -g <language> -o ./client
 ```
- Replace `<language>` with the desired programming language.

4. **Generate Server Stubs**
- Generate a server stub:
 ```bash
 openapi-generator-cli generate -i openapi.yaml -g <framework> -o ./server
 ```
- Replace `<framework>` with the desired framework.

5. **Run a Mock Server**
- Install Prism:
  ```bash
  npm install -g @stoplight/prism-cli
  ```
- Start the mock server:
  ```bash
  prism mock openapi.yaml
  ```

6. **Validate the OpenAPI File**
- Use [Swagger Validator](https://validator.swagger.io/):
  - Upload `openapi.yaml` or paste its content to check for errors.

This guide enables you to view, test, and utilize the API. Feel free to explore the OpenAPI Specification and integrate it into your development workflow.

## Troubleshooting

### Backend Issues

- **`Could not autowire` Errors**: Ensure that all dependencies are correctly defined in the `pom.xml` and that the repository interfaces are located in the correct package structure.

- **`Exception opening socket` for MongoDB**: Verify that MongoDB is running and accessible at `localhost:27017`. Check MongoDB logs for any connection issues.

- **`Build failed`**: Ensure that you are using Java 11 and that all dependencies are correctly installed. Check the `pom.xml` file for any missing dependencies.

- Regardless of the error, perhaps you can try running the following commands to clean and rebuild the project:

```bash
  mvn clean install
  ```

If the issue persists, you can run Maven with more detailed logging to identify the problem:

```bash
  mvn -X spring-boot:run
  ```

### Frontend Issues

- **Error: Cannot read properties of undefined (reading 'id')**: Ensure that the `employee` object in `EmployeeForm` is correctly initialized and that the `id` parameter is correctly passed. Check the `getEmployeeById` and `updateEmployee` functions for proper handling of data.

- **Chart Issues**: Ensure `Chart.js` and `react-chartjs-2` are correctly installed and configured. Verify that the chart data passed to components is in the correct format.

- Regardless of the error, perhaps you can try running the following commands to clean and rebuild the project:

```bash
  npm install
  ```

If the issue persists, you can run the React development server with more detailed logging to identify the problem:

```bash
  npm start --verbose
  ```

## Contributing

If you'd like to contribute to the project, please fork the repository and submit a pull request with your changes. Ensure that you follow the project's coding standards and include relevant tests for new features.

## License

This project is licensed under the **MIT License.** See the [LICENSE](LICENSE) file for details.

## Contact

For any questions or issues, please contact [hoangson091104@gmail.com](mailto:hoangson091104@gmail.com).

---

Thank you for checking out the **Employee Management Full-Stack Application!** Feel free to use this project for your own learning or development purposes.

Created with ❤️ by [Son Nguyen](https://github.com/hoangsonww) in 2024.

---

**[⬆ Back to Top](#employee-management-full-stack-application)**

Employee-Management-Fullstack-App

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README