Employee Management Service API

A REST-ful API to handle employee\people back-end operations

Table of Contents

Detailed information can be found below in the following sections

• Pre requisites
• How to run locally?
  • Using local installation
  • Running in container
• About Project
  • Description
  • Objective
  • Consumers
  • Tech & Specifications
  • General Validations
• Resources
  • Documentation
• Integration Tests
  • How to run integration tests

---

Pre requisites

• JDK 1.8+
• Maven 3+
• Docker runtime

Back to TOC

---

How to run locally?

• Clone the repository and change directory as below

  > git clone https://github.com/parmarhiiren/emp-mgmt.git
  > cd emp-mgmt
  

Running locally

• Run the following command to run the back-end API

  > mvn clean package -f ./emp-mgmt-backend
  

• Run the following command to run the back-end API

  > TODO --->>> npm install
  

Running in container

• Run the following commands

  > docker-compose up
  

Back to TOC

---

About

The details about the project and infrastructure can be found here

Description

It's an REST-ful API, which provides the capability to CREATE, RETRIEVE, SEARCH, and UPDATE employee\people

Back to TOC

Objective

The objective of the system is to provide an integration point for the front-end application

Back to TOC

Consumers

• emp-mgmt-frontend

Back to TOC

Technologies & Specifications

• Language: Java 1.8
• Java EE: Jee 8
• Runtime: Tomcat
• Spring 5
• H2 in memory database

Back to TOC

---

Resources

Documentation

• API Contract(Swagger UI)

Back to TOC