ProgressBoard

学習塾の講師が担当する生徒の授業内容をまとめ、一元管理するためのアプリです。
授業の内容を指導報告書としてまとめることを主な目的として、生徒や講師の管理や、チャット機能、アンケート機能なども実装しています。

URL

https://www.progressboard.net/

ログイン情報

生徒ログイン

Email:student1@test.com
Password:password123

講師ログイン

Email:teacher1@test.com
Password:password123

管理者ログイン:

Email:admin@test.com
Password:password123

ワイヤーフレーム

https://miro.com/app/board/uXjVPFUJM1A=/?share_link_id=210215022642

使用技術

###開発言語

• PHP 8.1.13
  世界的にエンジニアの数が多く、学習時に参考にできる情報が多いと考え
• Laravel 9.40.1
  Laravel Sailを使うことによる、環境構築の容易性により
• Composer 2.5.1
  依存関係にあるライブラリをまとめて管理するため使用
• Vite 4.0.4
  開発サーバーの起動の早さ、また新しい技術として学習のため
• Node.js 18.12.1
  JavaScriptの実行環境として
• npm 9.2.0
  Node.jsのパッケージ管理のため
• React 18.2.0
  最も流行っているフロントエンドフレームワークであり、Vue.jsよりもできる幅が広く、その分難しいと聞き、これを習得することによってよりフロントエンドの力がつくと思い
• Chakura UI 2.4.9
  CSSを記述することなく、シンプルなデザインで実装できるため
• React Icons 4.7.1
  アイコンの種類の多さ、知名度の高さから
• tailwindcss 3.2.4
  記述のシンプルさ、クラス命名も不要なことから

DB

• MariaDB 10.6.11
  将来性や、Lightsailでの実装のしやすさなどから

インフラ

• AWS(Lightsail)
  GCPと並び、デプロイのデファクトスタンダードのため

機能一覧

• ログイン機能
• 指導報告書のCRUD機能
• 生徒情報一覧（担当講師のハイライト）
• 講師情報一覧（担当制とのハイライト）
• ペジネーション機能
• 一覧画面での検索機能
• 講師のチャット機能
• マイページ編集機能
• アイコン画像設定機能
• 生徒、講師へのお知らせ機能
• アンケート機能
• 宿題機能

Gitのワークフロー

• 基本的にdevelopで開発を進めていく。
• デプロイ時、mainにマージする
• 新規機能開発の時にローカルのdevelopを最新にしてからfeatureブランチを切って開発を進める
  • featureブランチの規則はfeature/issue番号
• バグの修正の時はdevelopからhotfixブランチを切って開発を進める
  • hotfixブランチの規則はhotfix/issue番号

インストール方法

git clone https://github.com/yungra/ProgressBoard.git
cd ProgressBoard
composer install

.env.example をコピーして .envファイルを作成

cp .env.example .env

sailのエイリアスを登録

~/.zshrcに下記を追記

alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail'

sailを起動

sail up

アプリケーションキーの生成

sail artisan key:generate

データベースのマイグレーション

sail artisan migrate
sail artisan migrate:fresh --seed

フロントエンドのビルド

sail npm install
sail npm run dev

これで

http://localhost

にアクセスして、表示確認してください。