Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/penguineer/cleanuri-site-implementations

Implementations for cleanURI-supported sites
https://github.com/penguineer/cleanuri-site-implementations

Last synced: about 1 month ago
JSON representation

Implementations for cleanURI-supported sites

Awesome Lists containing this project

README

        

# cleanURI - Site Implementations

> Implementations for [cleanURI](https://github.com/penguineer/cleanURI) sites.

## 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-site-implementations
main-HEAD
runtime

```
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

[MIT](LICENSE.txt) © 2022-2023 Stefan Haun and contributors