プロジェクト

全般

プロフィール

Wiki » 履歴 » バージョン 1

AppTime 管理, 2024/04/21 08:10

1 1 AppTime 管理
# Wiki
2
3
## コーディング規約
4
5
基本的に下記に書かれている一般的なベストプラクティスを適用する
6
7
https://github.com/alexeymezenin/laravel-best-practices/blob/master/japanese.md
8
9
-   アーキテクチャは一般的なRESTで実装する
10
    ただし、`Auth`配下はLaravel Breezeによって自動生成されたもののため、このルールの適用外とする
11
12
-   外部APIサービスを利用するようなものなどはServiceクラスを作る
13
14
-   型定義を引数、プロパティ、戻り値に全て必ず記述する
15
16
-   PHPDocにServiceクラスなどを作る際はメソッドなどはわかりやすいように説明を記述する
17
18
-   テーブルに区分値がある場合は`app/Enums`配下にEnumを作る
19
20
    -   例に既にいくつか作っているため参考にしてください
21
    -   boolean型などの真偽値は定数を作らなくて良いです
22
23
-   フロントエンドはスタイリングにtailwindcssを使う
24
    -   Laravel Breezeに既に使われているため、統一する
25
26
- フロントエンドで動的な操作が必要になった場合、**Alpine.js**、複雑な操作は**Livewire**を利用する
27
    -   **jQueryは使わないこと**、Alpine.js、またはLivewireで同等のことがより簡単な記述で実現ができます
28
29
-   共通のスタイルのみ外に出し、基本は直接bladeファイルにtailwindでスタイルを書いていく