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

gitmemo's People

Contributors

kazuhe avatar renovate[bot] avatar

Watchers

 avatar

gitmemo's Issues

Markdown to HTML

  • 現在地の index.md を読み込む
  • HTML に変換する
  • ページへ表示する

Display memo

  • メモ一覧から任意のメモのリンクを押下すると、当該メモの内容が表示されること
  • ローカルのファイルを編集すると、リアルタイムでブラウザに反映されること

Improve Development

pnpm run dev/server ディレクトリ配下のファイルの変更も反映する

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource Name Replacement PR?
npm @types/marked Unavailable

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • Update dependency chokidar to v3.6.0
  • Update dependency date-fns to v2.30.0
  • Update dependency eslint to v8.57.0
  • Update dependency eslint-config-prettier to v8.10.0
  • Update dependency eslint-plugin-import to v2.29.1
  • Update dependency eslint-plugin-tailwindcss to v3.17.4
  • Update dependency marked to v4.3.0 (marked, @types/marked)
  • Update dependency node to v16.20.2
  • Update dependency prettier to v2.8.8
  • Update dependency tailwindcss to v3.4.7
  • Update dependency vitest to v0.34.6
  • Update dependency vue to v3.4.34
  • Update pnpm/action-setup action to v2.4.1
  • Update socket.io packages to v4.7.5 (socket.io, socket.io-client)
  • Update actions/checkout action to v4
  • Update actions/setup-node action to v4
  • Update dependency @tsconfig/strictest to v2
  • Update dependency @types/marked to v6
  • Update dependency @vitejs/plugin-vue to v5
  • Update dependency date-fns to v3
  • Update dependency eslint to v9
  • Update dependency eslint-config-prettier to v9
  • Update dependency marked to v13
  • Update dependency node to v20
  • Update dependency nodemon to v3
  • Update dependency prettier to v3
  • Update dependency typescript to v5
  • Update dependency vite to v5
  • Update dependency vitest to v2
  • Update dependency vue-tsc to v2
  • Update pnpm/action-setup action to v4
  • Update typescript-eslint monorepo to v7 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
  • 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/ci.yml
  • actions/checkout v3
  • pnpm/action-setup v2.2.2
  • actions/setup-node v3
nodenv
.node-version
  • node 16.16.0
npm
package.json
  • chokidar ^3.5.3
  • date-fns 2.29.3
  • express 4.18.1
  • gray-matter 4.0.3
  • marked 4.1.0
  • sanitize-html 2.7.1
  • socket.io 4.5.2
  • socket.io-client ^4.5.2
  • vue 3.2.39
  • vue-router ^4.1.5
  • vue-tsc 0.40.13
  • @tsconfig/strictest 1.0.1
  • @types/express 4.17.13
  • @types/marked 4.0.7
  • @types/sanitize-html 2.6.2
  • @typescript-eslint/eslint-plugin 5.37.0
  • @typescript-eslint/parser 5.37.0
  • @vitejs/plugin-vue 3.1.0
  • autoprefixer ^10.4.11
  • eslint 8.23.0
  • eslint-config-prettier 8.5.0
  • eslint-plugin-import 2.26.0
  • eslint-plugin-tailwindcss ^3.6.2
  • eslint-plugin-vue 9.4.0
  • nodemon 2.0.19
  • postcss ^8.4.16
  • prettier 2.7.1
  • tailwindcss ^3.1.8
  • typescript 4.8.2
  • vite 3.0.9
  • vitest 0.23.2

  • Check this box to trigger a request for Renovate to run again on this repository

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.