Employee Management Full-Stack Application

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!

Live Deployment

The Employee Management System full-stack app is deployed with Vercel and is live at 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. 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.

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.

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.
- 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-management-fullstack-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:

Dashboard Page:

Employee List Page:

Department List Page:

Add Employee Form:

Edit Employee Form:

Edit Department Form:

Profile Page:

Login Page:

Register Page:

404 Page:

Footer:

Responsive Design Example - Dashboard 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
`/api/employees`	GET	Get all employees
`/api/employees/{id}`	GET	Get an employee by ID
`/api/employees`	POST	Add a new employee
`/api/employees/{id}`	PUT	Update an employee by ID
`/api/employees/{id}`	DELETE	Delete an employee by ID
`/api/departments`	GET	Get all departments
`/api/departments/{id}`	GET	Get a department by ID
`/api/departments`	POST	Add a new department
`/api/departments/{id}`	PUT	Update a department by ID
`/api/departments/{id}`	DELETE	Delete a department by ID
`/swagger-ui.html`	GET	Access the Swagger UI documentation

File Structure

Employee-Management-Fullstack-App/
├── docker-compose.yaml
├── Jenkinsfile
├── openapi.yaml
├── README.md
├── package.json
├── .mvn/
│   └── wrapper
│       └── maven-wrapper.properties
├── kubernetes/
│   ├── configmap.yaml
│   ├── backend-deployment.yaml
│   ├── backend-service.yaml
│   ├── frontend-deployment.yaml
│   └── frontend-service.yaml
├── nginx/
│   ├── Dockerfile
│   └── nginx.conf 
├── backend/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   └── com/
│   │   │   │       └── example/
│   │   │   │           └── employeemanagement/
│   │   │   │               ├── EmployeeManagementApplication.java
│   │   │   │               ├── config/
│   │   │   │               │   └── CorsConfig.java
│   │   │   │               │   └── DataInitializer.java
│   │   │   │               ├── controller/
│   │   │   │               │   ├── DepartmentController.java
│   │   │   │               │   └── EmployeeController.java
│   │   │   │               ├── model/
│   │   │   │               │   ├── Department.java
│   │   │   │               │   └── Employee.java
│   │   │   │               ├── repository/
│   │   │   │               │   ├── DepartmentRepository.java
│   │   │   │               │   └── EmployeeRepository.java
│   │   │   │               ├── service/
│   │   │   │               │   └── DataInitializer.java
│   │   │   │               └── exception/
│   │   │   │                   └── ResourceNotFoundException.java
│   │   │   └── resources/
│   │   │       ├── application.properties
│   │   │       └── data.sql
│   │   └── test/
│   │       └── java/
│   │           └── com/
│   │               └── example/
│   │                   └── employeemanagement/
│   │                       └── EmployeeManagementApplicationTests.java
│   ├── .gitignore
│   ├── pom.xml
│   └── compose.yaml
│
└── frontend/
    ├── build/
    ├── public/
    │   ├── index.html
    │   └── favicon.ico
    │   └── manifest.json
    │   └── robots.txt
    │   └── icon-192x192.webp
    │   └── icon-512x512.webp
    ├── src/
    │   ├── components/
    │   │   ├── Dashboard.js
    │   │   ├── EmployeeList.js
    │   │   ├── EmployeeForm.js
    │   │   ├── DepartmentList.js
    │   │   ├── DepartmentForm.js
    │   │   └── Navbar.js
    │   ├── services/
    │   │   ├── employeeService.js
    │   │   └── departmentService.js
    │   ├── App.js
    │   ├── index.js
    │   ├── index.css
    │   ├── reportWebVitals.js
    │   ├── App.css
    │   └── theme.js
    ├── Dockerfile
    ├── postcss.config.js
    ├── tailwind.config.js
    └── package.json

Backend Setup

1. Prerequisites

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

For MacOS:

brew install openjdk@11
export JAVA_HOME=/usr/local/opt/openjdk@11

For Windows: Download OpenJDK 11 from 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

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 and Java JDK installed. Run the following command to install them:

For MacOS:
```
brew install maven
```
For Windows: Download Maven from https://maven.apache.org/download.cgi and follow the installation instructions.

Next, install the project dependencies:

mvn install

4. Configure the Application

Update src/main/resources/application.properties with your MySQL and MongoDB configuration:

# MySQL Configuration
spring.datasource.url=jdbc:mysql://localhost:3306/employee_management
spring.datasource.username=root
spring.datasource.password=password
spring.jpa.hibernate.ddl-auto=update

# MongoDB Configuration
spring.data.mongodb.uri=mongodb://localhost:27017/employee_management

Feel free to change the database name, username, and password, and even add more configurations as needed.

Alternatively, create a config.properties file in the backend directory and keep the application.properties file as is. Add the following properties to the config.properties file:

MYSQL_HOST=<mysql_host>
MYSQL_PORT=<mysql_port>
MYSQL_DB=<mysql_db>
MYSQL_USER=<mysql_user>
MYSQL_PASSWORD=<mysql_password>
MYSQL_SSL_MODE=<mysql_ssl_mode>
MONGO_URI=<mongo_host>

5. Start the Backend Server

Before starting the server, ensure that MySQL and MongoDB are running and properly configured on your local machine!

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

mvn spring-boot:run

The backend will be available at http://localhost:8080.

6. Access the API Endpoints

Get All Employees:

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

Get Employee by ID:

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

Get All Departments:

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

Get Department by ID:

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

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

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

Start the Backend Server: Ensure that the backend server is running. You can start the server by navigating to the backend directory and running:
```
mvn spring-boot:run
```
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

This will open the Swagger interface where you can explore the API endpoints.
Alternatively, for those who need the raw OpenAPI JSON, it is available at:

http://localhost:8080/v3/api-docs
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:

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

git clone https://github.com/hoangsonww/Employee-Management-Fullstack-App.git
cd frontend

2. Install Dependencies

Ensure you have Node.js and npm installed. Run the following command to install the required dependencies:

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:

REACT_APP_API_URL=http://localhost:8080/api

4. Start the Development Server

Run the following command to start the React development server:

npm start

The frontend will be available at http://localhost:3000.

5. Build for Production

To create a production build of your application, run:

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:

npm test

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:

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:

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:

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:

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.

Kubernetes

The project also includes Kubernetes configuration files in the kubernetes directory for deploying the application to a Kubernetes cluster. You can deploy the application to a Kubernetes cluster using the following command:

kubectl apply -f kubernetes

This command will create the necessary deployments, services, and config maps for the frontend and backend. You can access the application using the NodePort or LoadBalancer service created.

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 also includes a Jenkinsfile for automating the build and deployment process using Jenkins. You can create a Jenkins pipeline job and use the Jenkinsfile to build and deploy the application to a Kubernetes cluster.

Feel free to customize the Jenkins pipeline to suit your specific requirements and deployment process.

OpenAPI Specification

Using the `openapi.yaml` File

View the API Documentation

Open Swagger Editor.
Upload the openapi.yaml file or paste its content.
Visualize and interact with the API documentation.

Test the API

Import openapi.yaml into Postman:
- Open Postman → Import → Select openapi.yaml.
- Test the API endpoints directly from Postman.
Or use Swagger UI:
- Provide the file URL or upload it to view and test endpoints.

Generate Client Libraries

Install OpenAPI Generator:

npm install @openapitools/openapi-generator-cli -g

Generate a client library:

openapi-generator-cli generate -i openapi.yaml -g <language> -o ./client

Replace <language> with the desired programming language.

Generate Server Stubs

Generate a server stub:

openapi-generator-cli generate -i openapi.yaml -g <framework> -o ./server

Replace <framework> with the desired framework.

Run a Mock Server

Install Prism:
```
npm install -g @stoplight/prism-cli
```
Start the mock server:
```
prism mock openapi.yaml
```

Validate the OpenAPI File

Use Swagger Validator:
- 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:
```
mvn clean install
```
If the issue persists, you can run Maven with more detailed logging to identify the problem:
```
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:
```
npm install
```
If the issue persists, you can run the React development server with more detailed logging to identify the problem:
```
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 file for details.

Contact

For any questions or issues, please contact [email protected].

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 in 2024.

⬆ Back to Top

Name		Name	Last commit message	Last commit date
Latest commit History 439 Commits
.github		.github
.idea		.idea
.mvn/wrapper		.mvn/wrapper
backend		backend
frontend		frontend
img		img
kubernetes		kubernetes
nginx		nginx
.gitignore		.gitignore
Jenkinsfile		Jenkinsfile
LICENSE		LICENSE
README.md		README.md
docker-compose.yml		docker-compose.yml
openapi.yaml		openapi.yaml
package-lock.json		package-lock.json
package.json		package.json

License

hoangsonww/Employee-Management-Fullstack-App

Folders and files

Latest commit

History

Repository files navigation

Employee Management Full-Stack Application

Table of Contents

Overview

Live Deployment

Key Technologies

User Interface

API Endpoints

File Structure

Backend Setup

1. Prerequisites

2. Clone the Repository

3. Install Dependencies

4. Configure the Application

5. Start the Backend Server

6. Access the API Endpoints

7. API Documentation

Overview

How to Access the API Documentation

Benefits of Using Swagger UI

8. Backend JUnit Testing

Frontend Setup

1. Clone the Repository

2. Install Dependencies

3. Set Up Environment Variables

4. Start the Development Server

5. Build for Production

6. Test the Application (Optional)

Detailed Component Instructions

Dashboard.js

EmployeeList.js

EmployeeForm.js

DepartmentList.js

DepartmentForm.js

Navbar.js

Containerization

Kubernetes

LoadBalancer Service

Jenkins

OpenAPI Specification

Using the openapi.yaml File

Troubleshooting

Backend Issues

Frontend Issues

Contributing

License

Contact

About

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

Packages 0

Languages

`Dashboard.js`

`EmployeeList.js`

`EmployeeForm.js`

`DepartmentList.js`

`DepartmentForm.js`

`Navbar.js`

Using the `openapi.yaml` File

Packages