shohelasad/gitstatus

Approach and Assumption

• REST API Development: This Spring Boot Maven project is initialized with REST API, OpenAPI, and Actuator functionality.
• OpenAPI Documentation: Integrates OpenAPI documentation in controller for API exploration.
• Spring Boot Actuator: Exposes health and monitoring endpoints for application management.
• Configurable Properties: Leverages properties files (e.g., config.properties) to configure:
• Request Timeout: Set the maximum time (in milliseconds) a REST client waits for a response before timing out.
• Connection Pool Size: Control the number of concurrent connections the REST client can maintain.
• Popularity Score Threshold: Define the minimum score required for a repository to be considered popular.
• REST Client Configuration: Utilizes RestTemplate as the REST client with configurable timeout and connection pool size.
• Secure Access Token: Stores the access token for authentication in a properties file and sends it as an "Authorization" header with REST client requests.
• Production Readiness: Dockerfile and Docker Compose configurations are included to ensure production readiness and scalability for integration with other services.

Prerequisites

• Docker 19.03.x (for production level readiness)
• Docker Compose 1.25.x
• Maven 3

Used Technologies

• Spring Boot 3
• Lombok
• Actuator

How to run

Package application as a JAR file

mvn clean install -DskipTests

Package application as a JAR file

mvn test

Run with docker compose

docker-compose up -d

Run as Java -jar

java -jar target/githubrepo-0.0.1-SNAPSHOT.jar

Health status

http://localhost:8080/actuator/health

Open api docs

http://localhost:8080/swagger-ui/index.html