Giter VIP home page Giter VIP logo

gitmemo's Introduction

GitMemo

Development

🔌 Setup

pnpm を利用して依存関係をインストールする。

pnpm install

🔧 Start dev server

フロントエンドの開発サーバを起動する。

pnpm run dev:client

これは Vite によって起動されており単体では API へのリクエストは行えないが、下記のサーバーを起動した状態であればその限りではない。

サーバーを起動する。

# pnpm run build を先に実行しておく必要がある
pnpm run dev:server

これは nodemon によって起動され、src/server または src/domain 配下を編集すると自動で再起動される。

build されたフロントエンドのリソースを静的ファイルとして読み込んで利用しており、ブラウザで UI も含め確認することができる(pnpm run build:client を実行しない限りフロントエンドの編集は反映されない)。

📦 Create and run npm package locally

ローカル環境で npm パッケージを作成して playground ディレクトリで実行する。

pnpm run pack

これは npx gitmemo と同じ挙動になる。

内部で npm pack しており環境によってはうまくいかないかもしれない。npm ver.8.15.0 では意図した通りに動作した。

📂 Directory structure

オニオンアーキテクチャの**をベースにしている。

パッケージ名 役割
Commands コマンドラインでユーザーによって実行される
Api フロントエンドとやりとりをする
Repositories 抽象化されたデータ永続化ロジック
Controllers リクエストを元に Repository を Usecases に DI する
Usecases アプリケーション固有のロジック(このシステムが何をするか)を表現する
Domain ドメインオブジェクトとルール
Components UI コンポーネント
Pages ページを表示する
Public/Assets 画像等の静的ファイル
Composables ステートフルなロジック

gitmemo

UML
@startuml
rectangle src {
    rectangle Client {
        rectangle Pages
        rectangle Components
        rectangle PublicAssets
        rectangle Composables
        Components --> PublicAssets
        Components --> Composables
        Pages -> Components
        Pages -> PublicAssets
        Pages --> Composables
    }

    rectangle Server {
        rectangle Api
        rectangle Commands
        rectangle Controllers
        rectangle Repositories
        rectangle Usecases
        Controllers -> Repositories
        Commands --> Controllers
        Api --> Controllers
        Controllers --> Usecases: Repositoryを注入する
    }

    rectangle Domain

    Usecases --> Domain
    Repositories --> Domain
    Pages ---> Domain
    Components --> Domain
    Composables --> Domain
    Api ..> Client: ビルドされたリソースを参照する
}
@enduml

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.