Authenticator Project

This project is a Java Authenticator built with Spring Boot. It provides authentication functionalities using various dependencies and tools.

Table of Contents

• Description
• Prerequisites
• Dependencies
• Usage
• Building the Project
• Contributing
• License

Description

The Authenticator project is developed in Java using the Spring Boot framework. It aims to provide a robust authentication system with features such as Spring Data JPA, Spring Security, ModelMapper, and more.

Prerequisites

Make sure you have the following installed on your system:

• Java 17
• Maven 3.x

Dependencies

• Spring Boot Starter Actuator
• Spring Boot Starter Data JPA
• Spring Boot Starter HATEOAS
• Spring Boot Starter Security
• Spring Boot Starter Validation
• Spring Boot Starter Web
• Flyway Core
• Commons Lang 3
• ModelMapper
• Springdoc OpenAPI Starter WebMVC UI
• Java JWT
• Hibernate Envers
• H2 Database
• PostgreSQL Driver
• Lombok
• Spring Boot Starter Test
• Spring Security Test
• Rest Assured
• Testcontainers PostgreSQL

Usage

To use this project, follow these steps:

1. Clone the repository.
2. Build the project using Maven: mvn clean install.
3. Run the application: java -jar target/authenticator-0.0.1-SNAPSHOT.jar.

Building the Project

You can build the project using Maven:

mvn clean install

Using Docker

You can upload this project using docker-compose

mvn clean install
docker-compose up

Database Model

Suggestions for VSCode configs

settings.json

{
    "java.configuration.updateBuildConfiguration": "interactive",
    "files.exclude": {
        "**/.git": true,
        "**/.svn": true,
        "**/.hg": true,
        "**/CVS": true,
        "**/.DS_Store": true,
        "**/target": true,
        "**mvn**": true
    },
    "java.compile.nullAnalysis.mode": "automatic",
    "spring-boot.ls.java.home": "{path}\\jdk-17",
    "java.jdt.ls.java.home": "{path}\\jdk-17",
    "actionButtons": {
        "commands": [
            {
                "name": "MVN_TEST",
                "color": "yellow",
                "command": "mvn -o test"
            },
            {
                "name": "JACOCO",
                "color": "yellow",
                "command": "mvn jacoco:report"
            }
        ]
    }
}

launch.json

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "java",
            "name": "authenticator",
            "request": "launch",
            "cwd": "${workspaceFolder}",
            "console": "internalConsole",
            "mainClass": "com.moraes.authenticator.AuthenticatorApplication",
            "projectName": "authenticator",
            "env": {
                "server.port": 8080,
                "spring.profiles.active": "postgre"
            }
        }
    ]
}

Contributing

Contributions are welcome! Please follow the Contribution Guidelines.

License

This project is licensed under the MIT License.

Connect with Me

• LinkedIn: Suleiman Moraes