README.md

ME-ManagementSystem

1.要件定義

A.概要

クライアントが顧客のデータを集計し、売り上げの記録、年齢や時間などでソートできる web アプリケーションの作成を行う。もし可能なのであれば従業員への給与も計算したいとのこと。

B.システム構築図

C.背景

知り合いからの依頼。法人化し、Air レジを導入するまでの繋ぎとして安価に作成したいの相談を受けた為、作成することにした。

D.目的

クライアントの要望に答えるのはもちろんだが、チームメンバーの書いたソースをお互いにレビューするなど、チーム開発の経験を積む為。

2.業務要件

A.業務フロー

• 1.UI の作成(コウノ)

  • React + TypeScript で実装

• 2.バックエンド・DB(シマカワ)

  • Ruby on rails で実装
  • DB は MySQL

• 3.デプロイ

  • AWS へデプロイ予定だが、お金のかからないデプロイ先があればそれに変更
  • Heroku は重いのでなるべく避けたい

B.規模

極めて少人数が使用。

C.時期・時間

特に期限があるわけではないが、早ければ早いほど良い。

3.機能要件

A.機能

• 顧客データの送信フォーム

  • 年齢、時間、コース、オプションの有無など

• 売り上げページ

  • 入力されたコースやオプションを元に日々の売り上げの表示
  • もし可能ならばデータを元に従業員への給与も表示(別ページ？)

• 顧客データのソートページ

  • 週や時間帯など条件似合わせてソートできる物

B.入力項目

• 大まかな年齢(number)
• 利用時間(number)
• 利用コース(string)
• オプションの有無(boolean)
  • 衣装チェンジ(boolean)
  • 延長
    • 30 分単位(number)
  • ディープリンパ
    • 10 分単位(number)

4.非機能要件

A.システム方式

フォーム画面以外はログインしなければ入れない。

B.拡張性

今後追加される機能は記入項目の増減や、給与周りになる。元々のシステムが小規模なので、どんな方向性でもある程度は対応可能かと思われる。

C.継続性

あくまでAir レジ導入までの繋ぎなので継続性はない。

5.セキュリティー要件

A.情報セキュリティー

最低限は行うが、クレジット情報などの漏洩してはいけない情報がない為そこまで気にせずとも良い。

B.稼働環境

AWS または Heroku?

C.テスト

circleCI？jest?など？？