Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/android10/ktor-dockerizer
Gradle Plugin that facilitates docker integration when using gradle as a build system.
https://github.com/android10/ktor-dockerizer
build-system gradle java kotlin plugin plugins
Last synced: 25 days ago
JSON representation
Gradle Plugin that facilitates docker integration when using gradle as a build system.
- Host: GitHub
- URL: https://github.com/android10/ktor-dockerizer
- Owner: android10
- License: apache-2.0
- Created: 2021-03-09T20:46:20.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-26T19:44:09.000Z (over 3 years ago)
- Last Synced: 2024-11-13T08:31:06.184Z (3 months ago)
- Topics: build-system, gradle, java, kotlin, plugin, plugins
- Language: Kotlin
- Homepage: https://fernandocejas.com/
- Size: 190 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gradle Ktor Dockerizer
Gradle Plugin that facilitates docker integration with [Ktor](https://ktor.io/).
# Usage
- TODO
- Make sure your current user can run docker without sudo.
# Local Development
## Run Unit Tests
- `./gradlew runUnitTests` --> Runs all the Plugin Unit Tests.
## Sample Execution
From the root folder you can execute:
- `./gradlew clean build` --> Builds the project.
- `./gradlew clean test` --> Runs all tests.
- `./gradlew runKtor` --> Runs Ktor.
- `./gradlew generateKtorJar` --> Generates a Jar from the Ktor Project.
- `./gradlew buildKtorDockerImage` --> Builds Ktor Sample Docker Image.
- `./gradlew runKtorDocker` --> Runs Ktor in a Docker Container.
- `./gradlew runKtorDockerDetached` --> Runs Ktor in a Docker Container Detached.
- `./gradlew stopKtorDockerContainer` --> Stops Docker Container running Ktor.
## Test Manually Ktor Sample
From the root folder you can execute:
- `./gradlew buildKtorDockerImage`
- `./gradlew runKtorDockerDetached`
- `curl -i -X GET http://localhost:8080`
You should see:
```
HTTP/1.1 200 OK
Content-Length: 12
Content-Type: text/plain; charset=UTF-8
Hello World!
```
# TODOs
- [ ] Documentation.
- [ ] Support Docker Compose.
- [ ] Automate Test Execution.
- [ ] Automate Publishing.
# License
Copyright 2021 Fernando Cejas
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
