README.md

Spring REST API CRUD Example

• Technologies
• Features
• How to run the project
• Run docker

Technologies

• Spring Boot
• Spring Data JPA
• Docker
• H2 Database
• For Testing
  • AssertJ
  • JUnit
  • Mockito
  • Spring Framework Test

Features

• User CRUD
• DTO (Data Transfer Object)
• Docker
• Tests
  • Controller
  • Service
  • Repository

How to run the project

Follow this steps to run the project

1. mvn clean install

   • to build the project and download all maven dependencies

2. mvn spring-boot:run

   • to start the server

3. mvn test

   • to run the tests

Run Docker

To run docker, execute the commands below:

1. Execute the command to compile the project and generate .jar file

   • mvn clean package

2. Use the Docker command to create a Docker image

   • docker build -t [name] .

     • t: Name and tag for the docker image
     • . : The context for the build process

3. Run the container

   • docker run -p 8080 'your-application-name'

4. Test the application

   • Access the application using the browser
   • http://localhost:8080