Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

${{ values.name }} - Service Code Skeleton

Generated by Backstage on ${{ values.timestamp }}

Service Information

Property Value
Name ${{ values.name }}
Owner ${{ values.owner }}
Domain ${{ values.domain }}
Description ${{ values.description }}

Getting Started

Prerequisites

  • JDK 21+
  • Docker
  • kubectl (for local k8s testing)

Local Development

# Build
./gradlew build

# Run tests
./gradlew test

# Run locally
./gradlew bootRun

Docker

# Build image
docker build -t ${{ values.name }}:local .

# Run container
docker run -p 8080:8080 ${{ values.name }}:local

Project Structure

src/
├── main/
│   ├── java/io/helpdev/${{ values.name | replace("-", "") }}/
│   │   ├── Application.java
│   │   ├── config/
│   │   ├── controller/
│   │   ├── service/
│   │   ├── repository/
│   │   └── model/
│   └── resources/
│       ├── application.yaml
│       └── application-local.yaml
└── test/
    └── java/io/helpdev/${{ values.name | replace("-", "") }}/

API Endpoints

Method Path Description
GET /actuator/health Health check
GET /actuator/info Application info
GET /actuator/prometheus Metrics

Environment Variables

Variable Description Required
SPRING_PROFILES_ACTIVE Active profile No (default: default)
SERVER_PORT Server port No (default: 8080)

Deployment

This service is deployed via GitOps using Argo CD.

  • Repository: ${{ values.name }}-infra
  • HML: Triggered by deploy-hml label on PR
  • PROD: Triggered by GitHub Release

Documentation

Links