Add badges for technologies used in the project#62
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the root README.md “Built with” section to present the project’s tech stack as linked Shields.io badges instead of a text list.
Changes:
- Replaced the API/UI text list with badge-style links for backend and frontend technologies.
- Added badges for infrastructure/dependencies (e.g., PostgreSQL, Redis, RabbitMQ, MinIO) and UI libraries (e.g., TipTap, Recharts).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+52
to
+58
| [](https://go.dev/) | ||
| [](https://gin-gonic.com/) | ||
| [](https://gorm.io/) | ||
| [](https://www.postgresql.org/) | ||
| [](https://redis.io/) | ||
| [](https://www.rabbitmq.com/) | ||
| [](https://min.io/) |
There was a problem hiding this comment.
The new badges remove the prior API/UI breakdown and the note that RabbitMQ/MinIO are optional. That’s a documentation regression and may mislead readers into thinking those services are required for running the project. Consider reintroducing separate API/UI labels (or headings) and explicitly marking optional components (e.g., “optional” text or grouping under an “Optional” subheading).
Suggested change
| [](https://go.dev/) | |
| [](https://gin-gonic.com/) | |
| [](https://gorm.io/) | |
| [](https://www.postgresql.org/) | |
| [](https://redis.io/) | |
| [](https://www.rabbitmq.com/) | |
| [](https://min.io/) | |
| ### Backend (API) | |
| [](https://go.dev/) | |
| [](https://gin-gonic.com/) | |
| [](https://gorm.io/) | |
| [](https://www.postgresql.org/) | |
| [](https://redis.io/) | |
| [](https://www.rabbitmq.com/) *(optional)* | |
| [](https://min.io/) *(optional)* | |
| ### Frontend (UI) |
Comment on lines
+58
to
+65
| [](https://min.io/) | ||
| [](https://react.dev/) | ||
| [](https://reactrouter.com/) | ||
| [](https://vitejs.dev/) | ||
| [](https://www.typescriptlang.org/) | ||
| [](https://tailwindcss.com/) | ||
| [](https://tiptap.dev/) | ||
| [](https://recharts.org/) |
There was a problem hiding this comment.
All badges are currently on separate lines, which makes the “Built with” section very tall and harder to scan. Consider grouping badges onto fewer lines (or two grouped blocks for API/UI) so the section stays compact while still keeping the links.
Suggested change
| [](https://min.io/) | |
| [](https://react.dev/) | |
| [](https://reactrouter.com/) | |
| [](https://vitejs.dev/) | |
| [](https://www.typescriptlang.org/) | |
| [](https://tailwindcss.com/) | |
| [](https://tiptap.dev/) | |
| [](https://recharts.org/) | |
| [](https://min.io/) [](https://react.dev/) [](https://reactrouter.com/) [](https://vitejs.dev/) | |
| [](https://www.typescriptlang.org/) [](https://tailwindcss.com/) [](https://tiptap.dev/) [](https://recharts.org/) |
Comment on lines
+64
to
+65
| [](https://tiptap.dev/) | ||
| [](https://recharts.org/) |
There was a problem hiding this comment.
The TipTap and Recharts badges use logos for different projects (prosemirror and chartdotjs). This can be confusing for readers skimming the tech stack. If there isn’t an official Simple Icons logo available, consider omitting the logo= parameter (text-only badge) or using a more generic/icon-appropriate logo.
Suggested change
| [](https://tiptap.dev/) | |
| [](https://recharts.org/) | |
| [](https://tiptap.dev/) | |
| [](https://recharts.org/) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the
README.mdto enhance the "Built with" section. Instead of a plain text list, it now uses visually appealing badges with links for each technology used in the project, making it easier for readers to identify and access information about the project's tech stack.README improvements: