CONTRIBUTING.md

Contribution Guide

本レポジトリへのコントリビュート方法についてのガイドです。

はじめに

本レポジトリで使う技術の入門教材をリストアップしました。 経験のない方はご活用ください。

Command Line 入門

• Command Line | Progate

Git 入門

• サル先生の Git 入門 | Backlog
• Git | Progate

GitHub 入門

• GitHub の概要 - Learn | Microsoft Docs
• Introduction to GitHub | GitHub Skills

HTML / CSS 入門

• HTML & CSS | Progate

PHP 入門

• PHP | Progate

MySQL 入門

• MySQL の開発環境を用意しよう (mac) | Progate
• MySQL の開発環境を用意しよう (Windows) | Progate
• MySQL でデータベースを作成しよう | Progate
• MySQL 入門 | Qiita

MAMP を使うと楽に環境構築ができます。

Laravel 入門

• Laravel 入門 | Qiita

Vue.js 入門

• Vue.js チュートリアル

Nuxt.js 入門

• Get Started with Nuxt
• Nuxt 3を使いこなすために基礎から徹底解説

開発環境構築

レポジトリのクローン

レポジトリをクローンします。

git clone git@github.com:chorkleines/kleines-mypage.git

API (Laravel)

API は Laravel で書かれています。 ソースコードは api/ ディレクトリにあるので移動しましょう。

cd api

PHP のインストール

PHP8 (>=8.0.21) をインストールしてください。

依存ライブラリのインストール

composer install
composer install --working-dir=./tools/php-cs-fixer

データベース作成

MySQL データベースを作成してください。 データベース名は kleines_mypage とします。（任意の名前に変更可能です）

.env ファイルの変更

.env ファイルを作成してください。

cp .env.example .env

APP_NAMEを以下のように変更してください。

APP_NAME="Kleines Mypage"

テータベースの接続設定を行ってください。（自分の環境に合わせて設定してください）

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=kleines_mypage
DB_USERNAME=root
DB_PASSWORD=root

Laravel のセットアップ

アプリケーションキーを生成して下さい。

php artisan key:generate

テーブルを作成します。

php artisan migrate

初期ユーザーを作成します。

php artisan db:seed

以下のユーザーが作成されます。

Email: admin@chorkleines.com
Password: password

サーバーを立ち上げてみましょう。

php artisan serve

続いて、クライアント側のサーバーを起動してログインできるか確認してみます。

クライアント (Nuxt.js)

クライアントは Nuxt.js で書かれています。 ソースコードは client/ ディレクトリにあるので移動しましょう。

cd ../client

依存ライブラリのインストール

npm install

サーバーの起動

npm run dev

無事ログインができたら開発環境構築は完了です！

Docker を使う方法

Docker を利用した環境構築の方法も記しておきます。 この方法はアプリケーションを実行する上では使いやすいですが、開発時の利用はお勧めしません。 Docker Desktop をダウンロードしてインストールしてください。

アプリケーションの起動

以下のコマンドを実行して API サーバー・クライアントを起動します。

docker-compose up -d --build

デフォルトでは以下のユーザーが作成されています。

Email: admin@chorkleines.com
Password: password

http://localhost:3000 にアクセスして上記のユーザーでログインしてください。 無事ログインができたら開発環境構築は完了です！

Pull Request

コードを修正する場合は Pull Request (PR) を作成してください。

PR を merge する前には、原則として PR を merge する前に他のメンバーから approve をもらってください。 そのため、Reviewer にメンバーを誰か指定してください。Assignees には自分を指定し、Labels は適切なものを選択してください。

細かい PR は Issue を立てずに提出しても問題ありません。 修正・改善内容に疑問がある場合は、Issue を立てて相談するようにしてください。

コーディング規約

コードの差分をできる限り減らすため、フォーマッターを指定しています。 コードを編集したら以下のコマンドを実行してコードを整形してください。

./format.sh

PR を作成すると GitHub Actions が起動し、フォーマットのチェックが行われます。 チェックを通るまで PR を merge することはできません。 チェックに通らなかったらエラーを確認して再度コードの整形を行ってください。