Osakana

「あとで読む」記事を管理できるWebアプリ

ユーザガイド

ユーザとして利用する場合、DockerとDocker Composeによる構築を推奨します。

# Dockerネットワークの作成
$ make network

# Dockerイメージのビルド
$ make build

# Dockerコンテナの起動
$ make up

# Dockerコンテナの停止
$ make down

開発者ガイド

開発者として利用する場合、設定変更の容易であることやホットリロードを利用できる等の理由から、以下のドキュメントに従ってホストマシン上に直接構築することを推奨します。

• Gitフック
• 全文検索エンジン(Meilisearch)
• サーバ(FastAPI)
• ダッシュボード(Vite + preact-ts)

アーキテクチャ

• データ追加時の動作

ディレクトリ構成

.
├── LICENSE                             # ライセンス(AGPLv3)
├── Makefile                            # Docker Compose関連のスクリプト
├── README.md
├── dashboard
│   ├── .env                            # 環境変数
│   ├── .env.example                    # 環境変数の例
│   ├── .gitignore
│   ├── .node-version                   # nodenvが求めるNode.jsのバージョン
│   ├── Dockerfile
│   ├── README.md
│   ├── compose.yml
│   ├── default.conf.template           # Dockerfileから使用されるnginxの設定
│   ├── index.html
│   ├── package-lock.json
│   ├── package.json
│   ├── public
│   ├── src
│   │   ├── api
│   │   │   ├── endpoints               # APIとの通信処理
│   │   │   ├── errors                  # APIとの通信で固有に発生するエラーの定義
│   │   │   └── types                   # APIとの通信で固有に使用する型定義
│   │   ├── assets
│   │   ├── errors                      # ダッシュボード全体で使用されるエラーの定義
│   │   ├── index.css
│   │   ├── main.tsx
│   │   ├── pages                       # 各ページの定義
│   │   ├── types                       # ダッシュボード全体で使用される型定義
│   │   └── vite-env.d.ts
│   ├── tsconfig.json
│   ├── tsconfig.node.json
│   └── vite.config.ts                  # ダッシュボード全体の設定
├── engine
│   ├── .env                            # 環境変数
│   ├── .env.example                    # 環境変数の例
│   ├── .gitignore
│   ├── README.md
│   ├── compose.yml
│   └── data                            # Meilisearchが保持するデータ
├── hooks
│   ├── pre-commit.sh                   # pre-commitの設定(リンター、フォーマッタの実行)
│   ├── README.md
│   └── setup.sh                        # Gitフックの設定
├── images                              # ドキュメントで利用する画像
└── server
    ├── .env                            # 環境変数
    ├── .env.example                    # 環境変数の例
    ├── .flake8                         # Flake8の設定
    ├── .gitignore
    ├── .isort.cfg                      # isortの設定
    ├── .node-version
    ├── Dockerfile
    ├── README.md
    ├── api
    │   ├── errors
    │   │   ├── docs.py                 # エラーのドキュメント
    │   │   ├── handlers.py             # エラーハンドラ
    │   │   ├── register.py             # エラーハンドラの登録
    │   │   └── responses.py            # エラーのレスポンス
    │   ├── routes                      # APIのルーティング
    │   └── schemas                     # APIのスキーマ
    ├── compose.yml
    ├── db
    │   ├── __init__.py
    │   ├── client.py                   # Meilisearchのクライアント
    │   ├── migrations                  # DBマイグレーション
    │   ├── models                      # データモデル
    │   ├── repos                       # リポジトリ
    │   └── settings.py                 # Meilisearchの設定
    ├── services
    │   ├── morphological_analysis.py   # 形態素解析を行うサービス
    │   ├── ngrams.py                   # n-gramを行うサービス
    │   ├── timezone.py                 # タイムゾーン関連の処理
    │   └── web_scraping.py             # Webスクレイピングを行うサービス
    ├── main.py                         # APIのエントリポイント
    ├── package-lock.json
    ├── package.json
    ├── poetry.lock
    ├── pyproject.toml
    └── settings.py                     # API全体の設定