https://github.com/softwaremill/maven-badges
A node.js implementation of https://github.com/jirutka/maven-badges, originally created in ruby.
https://github.com/softwaremill/maven-badges
Last synced: 10 months ago
JSON representation
A node.js implementation of https://github.com/jirutka/maven-badges, originally created in ruby.
- Host: GitHub
- URL: https://github.com/softwaremill/maven-badges
- Owner: softwaremill
- License: other
- Created: 2018-07-05T12:58:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T22:42:38.000Z (about 1 year ago)
- Last Synced: 2024-10-30T00:46:26.925Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 2.44 MB
- Stars: 86
- Watchers: 26
- Forks: 18
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Badges for Maven projects
[](https://github.com/softwaremill/maven-badges/actions/workflows/ci.yml)
A node.js implementation of [maven-badges](https://github.com/jirutka/maven-badges), originally created in Ruby.
We've migrated this project to node.js for maintainability reasons.
## Description
Badges! These tiny pictures with label and some numbers, you see them in many GitHub readmes. We all love them, yeah?
Travis, Coveralls, Code Climate, Gemnasium, Gem, PyPi, npm…
However, most of them are not usable for Java/Groovy guys and that’s quite sad, isn’t it?
## Usage
```
https://maven-badges.herokuapp.com/{repository}/{group_id}/{artifact_id}/badge.(svg|png)?style={style}
```
where `repository` is one of:
- `maven-central` points to https://search.maven.org/
- `sonatype-central` points to https://central.sonatype.com/
use repository where your artifact is published to.
where `style` can be one of:
- `plastic`
- `flat`
- `flat-square`
- `for-the-badge`
- `social`
check [Styles](https://shields.io/#styles) section at [shields.io](https://shields.io/).
### No semver versions
You can try to use `gav=true` parameter to bypass semver problem - when some artifacts are following semver pattern,
and some don't, in such case try to use `gav`:
```
https://maven-badges.herokuapp.com/maven-central/{group_id}/{artifact_id}/badge.(svg|png)?style={style}&gav=true
```
### Hardcode version
You can also specify exact version to show on badge, just use `?version=x.x.x` as follow:
```
https://maven-badges.herokuapp.com/maven-central/cz.jirutka.rsql/rsql-parser/badge.svg?version=2.0.0
```
### Examples
```
[](https://maven-badges.herokuapp.com/maven-central/cz.jirutka.rsql/rsql-parser)
```
[](https://maven-badges.herokuapp.com/maven-central/cz.jirutka.rsql/rsql-parser)
```
[](https://maven-badges.herokuapp.com/maven-central/cz.jirutka.rsql/rsql-parser)
```
[](https://maven-badges.herokuapp.com/maven-central/cz.jirutka.rsql/rsql-parser)
```
[](https://maven-badges.herokuapp.com/maven-central/cz.jirutka.rsql/rsql-parser)
```
[](https://maven-badges.herokuapp.com/maven-central/cz.jirutka.rsql/rsql-parser)
## Development
You will need a running redis instance - use docker: `docker run -p 6379:6379 --name maven-badge-redis -d redis`
Start the TypeScript compiler in watch mode: `npm run tsc:watch`
Start the application: `npm run serve`
To run the tests suite, simply run `npm test`
## License
This project is licensed under [Apache 2.0 license]( http://www.apache.org/licenses/LICENSE-2.0).