ittokunvim xyz

ittokunvim-xyzはittokunvimが公開しているWebサイトです

準備

このプロジェクトを立ち上げるためにはDockerが必要になります。 以下のURLにアクセスしてインストールしましょう。

Docker

次に環境変数を設定するために、.env.localファイルを作成します。 見本として.env.exampleファイルを作成しているので、これを参考に変数を設定します。

以下のコマンドを実行するとスムーズに設定することが可能です。

# .env.exampleファイルをコピーし、.env.localファイルを作成
cp .env.example .env.local
# プライベートIPアドレスを確認
make echo_ip

最後にDockerでビルドする際に、リポジトリをクローンする処理の時にGitHubのSSHキーが必要になります。

以下にGitHubにSSHキーを設定する方法について書かれているドキュメントのURLを載せていますので、 そちらを参考にしてキーの設定を行うと良いでしょう。

https://zenn.dev/schnell/articles/0e1c2e9db5c08d

https://zenn.dev/ryo_f/articles/27f223203481ef

これで準備は整いました！お疲れ様です！

プロジェクトを立ち上げる

ではDockerを使用してビルドをして、サーバーを立ち上げてみましょう！

# ビルド
make build
# 立ち上げ
make up

これでプロジェクトが動作するはずです。以下のURLにアクセスして確認してみましょう！

http://localhost:3000

便利なコマンド

このプロジェクトにはMakefileに開発に便利なコマンドが書かれています。

以下にコマンドの用途と使い方を記したので参考に

# プロジェクトをビルド
make build
# プロジェクト立ち上げ
make up
# プロジェクトを終了
make down
# IPアドレスの確認
make echo_ip
# プロジェクトのappコンテナにアクセス
make app_init
# プロジェクトのdocsコンテナにアクセス
make docs_init
# プロジェクトのgamesコンテナにアクセス
make games_init