employee-rest

A Spring Boot Rest API with a Vue.js client

Sample running demo at https://employee-rest.herokuapp.com/

About

employee-rest is an example of using Spring Boot to implement a Rest API and a Vue.js client to communicate with the API.

The backend service offers the below Actions:

POST	/api/employees	     create new Employee
GET	/api/employees	     retrieve all Employee
GET	/api/employees/:id   retrieve a Employee by :id
PUT	/api/employees/:id   update a Employee by :id
DELETE	/api/employees/:id   delete a Employee by :id
DELETE	/api/employees	     delete all Employee

Prerequisites

• Java 1.8 Developlment Kit
• Maven 3.6
• Node to recompile frontend (only needed if changes to frontend are required)

Project setup

1. cd to backend folder
2. rename /src/main/resources/application.properties.h2 to /src/main/resources/application.properties to use H2 in-memory database.
3. or rename /src/main/resources/application.properties.mysql to /src/main/resources/application.properties to use MySql database.
4. enter database configuration in /src/main/resources/application.properties
5. run the command mvn spring-boot:run
6. go to http://localhost:8080

Frontend notes

Front end files built with Vue.js are located in the frontend folder. Node.js is required to be installed for the frontend to be built, but this is only necessary if changes are made to the front end files.

To build the front end follow the steps below:

1. cd to backend folder
2. run npm install
3. run npm run build

Note that build files are automatically placed in the backend public folder