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
Installed:
- Docker
- JDK 21
Provide instructions on how to get the application up and running. Include steps such as:
- Clone the repository:
git clone https://github.com/your-username/your-app.git
- Navigate to the project directory
- Configure
GITHUB_API_TOKEN
,GITHUB_API_BASE_URL
, andGITHUB_API_VERSION
environment variables. - Build & run Option 1 (Gradle):
- Build the project:
./gradlew build
- Run the application:
./gradlew bootRun
- Build the project:
- Build & run Option 2 (Docker):
- Build docker image
docker build .
- Run container
docker run
- Build docker image