Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 944 Bytes

README.md

File metadata and controls

34 lines (21 loc) · 944 Bytes

Comments/Context from me

In general, I'd ask a bunch of questions regarding the requirements and the business need for this proxy service, but for the simplicity and to avoid back-and-forth I made a bunch of assumptions.

And when it comes to testing- normally, I'd cover more test cases.

Overview

// overview

Prerequisites

Installed:

  • Docker
  • JDK 21

Getting Started

Provide instructions on how to get the application up and running. Include steps such as:

  1. Clone the repository: git clone https://github.com/your-username/your-app.git
  2. Navigate to the project directory
  3. Configure GITHUB_API_TOKEN, GITHUB_API_BASE_URL, and GITHUB_API_VERSION environment variables.
  4. Build & run Option 1 (Gradle):
    • Build the project: ./gradlew build
    • Run the application: ./gradlew bootRun
  5. Build & run Option 2 (Docker):
    • Build docker image docker build .
    • Run container docker run