Sample implementation of Kotlin+Spring+GraphQL
Branch: master
Clone or download
shiraji Merge pull request #3 from nobuoka/fix/gitignore-for-intellij-idea-wi…
…th-gradle-or-maven

Remove .idea/modules.xml file because it will be generated on import
Latest commit 17f8da8 Feb 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci First commit Dec 14, 2018
.idea Fix .gitignore for IntelliJ IDEA with Gradle or Maven Feb 9, 2019
gradle/wrapper First commit Dec 14, 2018
src First commit Dec 14, 2018
.gitignore Fix .gitignore for IntelliJ IDEA with Gradle or Maven Feb 9, 2019
LICENSE Add LICENSE Dec 14, 2018
README.md Fix running tests commands Dec 15, 2018
build.gradle.kts First commit Dec 14, 2018
docker-compose.yml First commit Dec 14, 2018
gradle.properties First commit Dec 14, 2018
gradlew First commit Dec 14, 2018
gradlew.bat First commit Dec 14, 2018
settings.gradle.kts First commit Dec 14, 2018

README.md

kotlin-graphql-sample

CircleCI

これはUbieが開発しているKotlin+SpringBoot+GraphQLのサンプル実装です。

DB

E-R図

環境構築

Docker

docker-composeを利用してDockerを立ち上げています。それぞれインストールして下さい。 https://docs.docker.com/compose/install/

Editor

どのようなEditorを使っても構いませんが、Ubieでは主にIntellij Ultimateを利用しています。

起動方法

以下のコマンドを実行します。

docker-compose up

起動した状態で http://localhost:8090/graphiql にアクセスすると、GraphiQLにアクセス出来ます。

テスト

テストの実行

docker exec -it sample-app ./gradlew test

上記コマンドにより、テストが実行され、レポートがbuild/reports/tests/test/index.htmlとして出力されます。

コードカバレッジの測定

docker exec -it sample-app ./gradlew jacocoTestReport

テストを実行した後に上記コマンドにより、コードカバレッジの測定が実行され、レポートがbuild/reports/jacoco/test/html/index.htmlとして出力されます。

静的解析ツールの実行

./gradlew ktlintCheck

上記コマンドにより、Kotlinコードのスタイルチェック等の静的解析が実行されます。 レポートがbuild/reports/ktlintに、ktlint-main.txtktlint-test.txtというファイルで出力されます。

また、コード整形を下記のコマンドで実行できます。

./gradlew ktlintFormat

コーディングスタイル

https://github.com/ubie-inc/kotlin-coding-style

Contribution

このプロジェクトはUbieの環境と同期させるため、Ubieの環境と大きく離れてしまう修正は取り込む事が出来ません。

しかし、パッケージ変更を含まない修正であればどんどん取り込みますので、Pull Requestお待ちしております。

もし、どうすればいいかわからないという場合は、一旦issueを挙げてもらえると良いです。日本語か英語どちらでも構いません。