Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/penguineer/cleanuri-common

Common definitions and functions for the cleanURI service.
https://github.com/penguineer/cleanuri-common

library micronaut url-shortener-microservice

Last synced: about 1 month ago
JSON representation

Common definitions and functions for the cleanURI service.

Host: GitHub
URL: https://github.com/penguineer/cleanuri-common
Owner: penguineer
License: mit
Created: 2022-07-22T14:35:46.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-11-21T00:14:46.000Z (about 1 year ago)
Last Synced: 2024-05-02T02:12:35.555Z (8 months ago)
Topics: library, micronaut, url-shortener-microservice
Language: Java
Homepage:
Size: 47.9 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

# cleanURI - Common

> Common definitions and functions for the [cleanURI](https://github.com/penguineer/cleanURI) service.

## Deployment

### Including the library

The library can be included with [jitpack](https://jitpack.io/) with two additions to the project's POM file.

Adding the jitpack repository:
```xml

jitpack.io
https://jitpack.io

```

Adding the library:
```xml

com.github.penguineer
cleanURI-common
main-HEAD
compile

```
Replace the `version` tag with the desired release.

Please refer to the [jitpack documentation](https://jitpack.io/) on using alternative build systems.

### Development

This project uses the [Micronaut Framework](https://micronaut.io/).

Version numbers are determined with [jgitver](https://jgitver.github.io/).
Please check your [IDE settings](https://jgitver.github.io/#_ides_usage) to avoid problems, as there are still some unresolved issues.
If you encounter a project version `0` there is an issue with the jgitver generator.

If access to the GitHub packages repository is not available, please check *Including the library from Local installation* on how to make the artifact available locally.

## Maintainers

* Stefan Haun ([@penguineer](https://github.com/penguineer))

## Contributing

PRs are welcome!

If possible, please stick to the following guidelines:

* Keep PRs reasonably small and their scope limited to a feature or module within the code.
* If a large change is planned, it is best to open a feature request issue first, then link subsequent PRs to this issue, so that the PRs move the code towards the intended feature.

## License