2. Getting Started

This guide will help you get started with setting up your environment to deploy the application successfully.

Prerequisites

To successfully build and run the application, ensure you have the following:

• Java 17 or higher
• Java SDK/JDK
• An IDE or Text editor

Folder Structure

Below is the folder structure for the project.

hng_boilerplate_java_web
├── Dockerfile
├── README.md
├── deploy.sh
├── docker-compose.yml
├── init-db.sh
├── mvnw
├── mvnw.cmd
├── nginx.conf
├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── hng_java_boilerplate
    │   │       ├── Program.java
    │   │       ├── config
    │   │       │   └── DatabaseSeeder.java
    │   │       ├── organisation
    │   │       │   ├── entity
    │   │       │   │   └── Organisation.java
    │   │       │   └── repository
    │   │       │       └── OrganisationRepository.java
    │   │       ├── product
    │   │       │   ├── entity
    │   │       │   │   └── Product.java
    │   │       │   └── repository
    │   │       │       └── ProductRepository.java
    │   │       ├── profile
    │   │       │   ├── entity
    │   │       │   │   └── Profile.java
    │   │       │   └── repository
    │   │       │       └── ProfileRepository.java
    │   │       ├── user
    │   │       │   ├── controller
    │   │       │   │   └── UserController.java
    │   │       │   ├── dto
    │   │       │   │   └── GetUserDto.java
    │   │       │   ├── entity
    │   │       │   │   └── User.java
    │   │       │   ├── repository
    │   │       │   │   └── UserRepository.java
    │   │       │   └── service
    │   │       │       └── UserService.java
    │   │       ├── util
    │   │       │   └── UUIDGenarator.java
    │   │       └── welcome
    │   │           └── WelcomeController.java
    │   └── resources
    │       ├── application.properties
    │       └── db
    │           └── migration
    │               └── V1__init_database.sql
    └── test
        └── java
            └── hng_java_boilerplate
                ├── ProgramTest.java
                └── welcome
                    └── WelcomeControllerTest.java