Skip to content

Latest commit

 

History

History
133 lines (85 loc) · 2.74 KB

README.md

File metadata and controls

133 lines (85 loc) · 2.74 KB

はじめに

このアプリの詳細は Wiki の「Home」にまとめています。

実行環境

  • Docker 25.0.2
  • Docker Compose v2.24.3-desktop.1

動作確認環境

以下の環境で動作確認済みになります。

mac

  • チップ: Apple M1
  • メモリ: 8GB
  • macOS: macOS Sonoma v14.3

windows

  • プロセッサ: Intel Core i7
  • 実装 RAM: 16.0 GB
  • エディション: Windows 10 Pro
  • バージョン: 22H2

※
Windows の場合は、make コマンドが使用できる状態1で実施してください。
インストールせずに実施する場合は、Makefile を参照して実施をお願いします。

スタートガイド

💻 ローカル環境構築方法

コマンドでの実行方法を記載します。
VSCode での実行方法は、Wiki の「スタートガイド ‐ VSCode 使用」を参照してください。

1. リポジトリをローカル環境にクローン

git clone https://github.com/serina-yam/todo-app-with-java-gradle.git
cd todo-app-with-java-gradle

2. application.properties の置き換え

以下にあるファイルを、AWS S3 で配布したファイルに置き換えてください。
パス： app/src/main/resources/application.properties

コマンドを使用する場合の例です。

mv -f /Users/XXXXXX/Desktop/application.properties app/src/main/resources/application.properties

3. Docker Compose を使用して、プロジェクトの実行環境をセットアップ

make setup

4. アプリケーションのビルド

make build

5. アプリケーションの実行

make run

6. ブラウザで確認

http://localhost:8080

7. データベース管理ツールをブラウザで開く

http://localhost:9000

⛏️ ビルド方法

1. ビルド

make build

2. クリーンアップ

make clean

⛑️ テスト実行方法

1. テスト実行

make test

2. ビルド時に作成されたテスト結果を見る

make open-test

3. ビルド時に作成されたカバレッジ結果を見る

make open-coverage

📖ドキュメント

1. Javadoc生成

make javadoc

2. 作成されたJavadocを見る

make open-javadoc

Footnotes

  1. GnuWin32 をインストールすることで使用可能になります ↩