ノードクリーンアーキテクチャテンプレート


序文


高度にスケーラブルな、安定したコードベースを書くことは、維持するのが簡単であるほとんどのエンジニアのための夢です、そして、ソフトウェア建築が解決するのを目指す問題のいくらかです.
ソフトウェアアーキテクチャはシステムの青写真となる.これは、システムの複雑さを管理し、コンポーネント間のコミュニケーションと調整メカニズムを確立するための抽象化を提供します.
多くのJavaScriptとTypeScriptのコードベースで私のキャリアを通して働いてきた、私はしばしば彼らはCのような、より確立された言語とは非常に異なっている確立されたアーキテクチャに準拠していないことを確認します.

テンプレート


テンプレートは、クリーンなアーキテクチャ原則に準拠し、確立された実践を奨励します.

機能

  • はじめに
  • 依存性注入
  • コマンドクエリ責任分離
  • 高テストカバレッジ(単位,積分,機能試験)
  • 自動エラー処理
  • ログ記録
  • バージョン管理API
  • 泥棒
  • プリサムオル
  • ジャミエリビンストン / ノードクリーンアーキテクチャ


    きれいなアーキテクチャ原則に従って、良い実行を奨励するノードテンプレート。


    クリーンアーキテクチャテンプレート


    きれいなアーキテクチャ原則に従って、良い実行を奨励するノードテンプレート.

    機能

  • はじめに
  • 依存性注入
  • コマンドクエリ責任分離
  • 高テストカバレッジ(単位,積分,機能試験)
  • 自動エラー処理
  • ログ記録
  • バージョン管理API
  • 泥棒
  • プリサムオル
  • 始める

  • 最新のインストールNode.js LTS
  • Dockerをインストールし、実行していることを確認します
  • クリエイト.envファイルcp .env.example .env
  • ランニングによるプロジェクト依存関係のインストールyarn install
  • docker ( local postgresのインスタンス)docker-compose up -d
  • データベースの作成npx prisma migrate deploy
  • 開発サーバyarn start
  • Swaggerに移動する http://localhost:3000/api-docs )
  • スクリプト


    ビルド生産束
    yarn build
    
    LINTプロジェクト
    yarn lint
    
    開発サーバ
    yarn start
    
    全テストを実行する
    yarn test
    
    ランユニットテスト
    yarn test:unit
    
    実行機能テスト( APIテスト)
    yarn test:functional
    
    View on GitHub

    クリーンアーキテクチャ


    きれいな建築は、多くの利益を提供する戦いテストされたソフトウェア建築です.

  • 非常にテスト可能:クリーンアーキテクチャを念頭に置いてテストを設計されて

  • フレームワーク独立:任意の特定のフレームワークからのツールに依存しません

  • ビジネスロジックはカプセル化されます:システムへの新しいエントリポイントを追加するのは簡単です

  • データベースから独立してください:あなたのアプリケーションの大部分は知らないでしょうか、どんなデータベースからそれを知っている必要があります.これは、ソースコードの大多数への変更なしで新しいデータベースを採用することができることを意味します

  • 柔軟性:リファクタリングとコードを維持する簡単になり、少しの努力を要求します
  • 読書による建築の詳細についてthis ロバートC .マーティンによるブログ柱.