https://github.com/ittokunvim/ittokunvim-xyz
ittokunvimが公開しているWebサイト
https://github.com/ittokunvim/ittokunvim-xyz
nextjs typescript vercel
Last synced: over 1 year ago
JSON representation
ittokunvimが公開しているWebサイト
- Host: GitHub
- URL: https://github.com/ittokunvim/ittokunvim-xyz
- Owner: ittokunvim
- Created: 2022-09-12T14:17:49.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T15:50:08.000Z (over 1 year ago)
- Last Synced: 2024-11-12T16:41:38.655Z (over 1 year ago)
- Topics: nextjs, typescript, vercel
- Language: TypeScript
- Homepage: https://ittokunvim.xyz
- Size: 17.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ittokunvim xyz
`ittokunvim-xyz`はittokunvimが公開しているWebサイトです
## 準備
このプロジェクトを立ち上げるためには`Docker`が必要になります。
以下のURLにアクセスしてインストールしましょう。
[Docker](https://www.docker.com/)
次に環境変数を設定するために、`.env.local`ファイルを作成します。
見本として`.env.example`ファイルを作成しているので、これを参考に変数を設定します。
以下のコマンドを実行するとスムーズに設定することが可能です。
```bash
# .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`を使用してビルドをして、サーバーを立ち上げてみましょう！
```bash
# ビルド
make build
# 立ち上げ
make up
```
これでプロジェクトが動作するはずです。以下のURLにアクセスして確認してみましょう！
http://localhost:3000
## 便利なコマンド
このプロジェクトには`Makefile`に開発に便利なコマンドが書かれています。
以下にコマンドの用途と使い方を記したので参考に
```bash
# プロジェクトをビルド
make build
# プロジェクト立ち上げ
make up
# プロジェクトを終了
make down
# IPアドレスの確認
make echo_ip
# プロジェクトのappコンテナにアクセス
make app_init
# プロジェクトのdocsコンテナにアクセス
make docs_init
# プロジェクトのgamesコンテナにアクセス
make games_init
```