diff --git a/README.md b/README.md index 16693c6..28ead4b 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,18 @@ プログラマー向けの学習コンテンツサイトです。 -## 実行手順 +## 必要な環境 -### 必要な環境 - -- Node.js (推奨: v18以上) -- pnpm - -### pnpmのインストール +- 必須 + - Node.js (推奨: v18以上) + - pnpm + - Git +- 任意 + - コマンドライン操作の練習用仮想環境 + - [VirtualBox](https://www.virtualbox.org/) + - [Vagrant](https://www.vagrantup.com/) + - PHP練習用環境 + - [Docker](https://www.docker.com/) pnpmがインストールされていない場合は、以下のコマンドでインストールしてください。 @@ -17,65 +21,51 @@ npm install -g pnpm ``` -### Vagrant仮想環境の利用(任意) +## 実行手順 -コマンドライン操作を学習するための練習用仮想環境をVagrantで用意しています。 -ローカル環境を汚さずにCLIの演習を行いたい場合にご利用ください。 - -#### 必要な環境 - -- [VirtualBox](https://www.virtualbox.org/) -- [Vagrant](https://www.vagrantup.com/) - -#### 起動方法 +このソースコードの取得 ```sh -cd vagrant -vagrant up -vagrant ssh +git clone https://git.souken-dev.com/git/h.sakamoto/hello-programmer-world.git ``` -詳細は `vagrant/` ディレクトリ内のファイルをご確認ください。 - -### セットアップ - -1. リポジトリをクローンします - -```sh -git clone -cd hello-programmer-world -``` - -2. 依存パッケージをインストールします +Webページの準備 (ライブラリのインストール) ```sh pnpm install ``` -### 開発サーバーの起動 +Webページの起動 ```sh pnpm dev ``` -開発サーバーが起動し、ブラウザで `http://localhost:4321` にアクセスできます。 +開発サーバーが起動し、ブラウザで にアクセスできます。 ファイルを編集すると、自動的にブラウザがリロードされます。 -### ビルド +## コマンドライン操作の練習用仮想環境の利用(任意) + +<./vagrant/README.md> をご確認ください。 + +## PHP練習用環境の利用(任意) + +PHPの練習用環境はDocker Composeで構築しています。 +以下のコマンドを実行して、環境を起動してください。 ```sh -pnpm build +docker compose up -d ``` -本番用のファイルが `dist/` ディレクトリに生成されます。 +起動が成功すると、以下のURLにアクセスすることでPHPの動作を確認できます。 +この環境では、PHPのコードを `./public/sample/` と `./public/playground/` に配置して実行できます。 -### プレビュー +- -ビルドしたファイルをローカルでプレビューできます。 +データベースの環境も同時に起動します。 +以下のページにアクセスして、データベースの管理ツールであるPhpMyAdminを利用できます。 -```sh -pnpm preview -``` +- ## 技術スタック diff --git a/vagrant/README.md b/vagrant/README.md new file mode 100644 index 0000000..b6551bc --- /dev/null +++ b/vagrant/README.md @@ -0,0 +1,42 @@ +# Vagrant仮想環境の利用(任意) + +コマンドライン操作を学習するための練習用仮想環境をVagrantで用意しています。 +ローカル環境を汚さずにCLIの演習を行いたい場合にご利用ください。 + +## 必要な環境 + +- [VirtualBox](https://www.virtualbox.org/) +- [Vagrant](https://www.vagrantup.com/) + +## 起動方法 + +```sh +cd vagrant +vagrant up +vagrant ssh +``` + +## ファイル構成 + +```plain +vagrant/ +├── README.md +├── Vagrantfile +├── attach.sh +├── recreate.sh +└── setup + └── init.sh +``` + +### README.md + +このファイルです。 + +### recreate.sh + +環境を再構築するためのスクリプトです。 +環境を新規構築したい場合や、環境をリセットしたい場合に実行してください。 + +### attach.sh + +生成された仮想マシンに接続するためのスクリプトです。