https://github.com/kengotoda/javadocky

An OSS clone of javadoc.io
https://github.com/kengotoda/javadocky

docker-compose javadoc nginx reactive-streams reactor spring-boot spring-webflux

Last synced: 25 days ago
JSON representation

An OSS clone of javadoc.io

• Host: GitHub
• URL: https://github.com/kengotoda/javadocky
• Owner: KengoTODA
• License: agpl-3.0
• Created: 2017-06-20T12:46:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T05:56:45.000Z (over 1 year ago)
• Last Synced: 2024-10-03T07:20:56.146Z (about 1 month ago)
• Topics: docker-compose, javadoc, nginx, reactive-streams, reactor, spring-boot, spring-webflux
• Language: HTML
• Homepage:
• Size: 8.35 MB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# javadocky

This project is a clone of [javadoc.io](http://javadoc.io/).

This is also a sandbox project to play with spring-boot v2.7.0, spring-webflux v5.3.8 and selenide v6.5.1.

![Build Status](https://github.com/KengoTODA/javadocky/workflows/Build/badge.svg)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=javadocky&metric=coverage)](https://sonarcloud.io/dashboard?id=javadocky)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/14582f2758734bd3a9c2076e210e4174)](https://www.codacy.com/gh/KengoTODA/javadocky/dashboard?utm_source=github.com&utm_medium=referral&utm_content=KengoTODA/javadocky&utm_campaign=Badge_Grade)

## How to build

```sh

$ docker-compose up --build

```

You can visit [http://localhost:8080/](http://localhost:8080/) to enjoy service.

### How to configure

You can [set property](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html), to configure Javadocky.

|name                      |default value                     |note    |

|--------------------------|----------------------------------|--------|

|javadocky.maven.repository|https://repo.maven.apache.org/maven2/  |URL of the Maven repository to download javadoc.jar|

## License

Copyright 2017-2022 Kengo TODA

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU Affero General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License

along with this program.  If not, see .