codecentric / codecentric/spring-boot-admin

Feature: UI NPM package

Open
#5,228 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: waiting-for-triage type: enhancement
Dominant language
Java
Stars
12.9k
Forks
3.1k
Avg merge
19h 1m
Merged PRs (30d)
61

Description

Hello.

I'm planning to build a custom view for SBA and I was reading about it in https://docs.spring-boot-admin.com/4.0.2/docs/samples/sample-custom-ui (I found no other more detailed sources).

I was wondering if it could be possible to package what's referenced in there as well as any other reusable piece of code (e.g.: components) in an npm package that we could add as dev dependency in order to have a better development experience.

Ideally I would like to be able to run npm run dev and have the UI fully rendered, but that's maybe too much.

Having already the - allow me the wrong term - types properly referenced so that TS and ESLint don't scream all the time would already be great.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked custom UI sample documentation and inspect the existing UI packaging and TypeScript/ESLint setup. Define the reusable UI code and type surface that should be consumable as an npm dev dependency, then determine whether npm run dev can render the UI. Done means the package scope and development workflow are documented and usable.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
developer-experience, frontend, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.