README.md

Shuiro Backend

プログラム採点システムのAPIサーバーです。

🤖 Tech Stack

• Framework:
  • Hono - Web application framework
• Open API:
  • Zod OpenAPI Hono - Define API schemas with Zod and validate values and types
  • Scalar API Reference - Generate API reference documentation from OpenAPI schemas
• Database:
  • Prisma - ORM for Node.js and TypeScript
  • SQLite - RDBMS
• Language:
  • TypeScript - JavaScript with syntax for types
• Runtime, Package Manager, and Task Runner:
  • Bun - JavaScript all-in-one toolkit (used for package management, task running, and more)
  • Node.js - JavaScript runtime (used for running JavaScript code outside of a web browser)

Directory Structure

ディレクトリ構成などは、ARCHITECTURE.md を参照してください。

🚀 Development

Prerequisites

Warning

Dev Containerにより開発環境を構築した場合は、以下はすでにインストールされています。

• Node.js
• Bun

それぞれ必要なバージョンは.tool-versionsを参照してください。

Tip

mise 等を利用している場合は、mise install によって上記のツールをインストールできます。

Setup

環境変数の設定

.env.example をコピーして .env ファイルを作成してください。

設定する環境変数は次の通りです。

• DATABASE_URL: データベースのURL。SQLite の DB ファイルのパスを指定してください（例：file:./dev.db）。詳しくは Prismaのドキュメント を参照してください。

Commands

依存関係のインストール

次のコマンドで依存関係をインストールします。

bun install

DBのマイグレーションと初期データの投入

次のコマンドでDBのマイグレーションと初期データの投入を行います。

bun run prisma migrate dev && bun run prisma db seed

Tip

デバッグ用に、最初からいくつかのフェイクデータを投入する場合は、次のコマンドを実行してください。

bun run prisma db seed -- --fake

開発サーバーの起動

次のコマンドで開発サーバーを起動します。backend ディレクトリに移動してから実行してください。

bun run dev

http://localhost:3000 にてAPIサーバーが起動します。 また、http://localhost:3000/api/docs にてAPIリファレンスが表示されます。

テスト

次のコマンドでテストを実行します。

bun run test

ビルド

次のコマンドでバックエンドのビルドを行います。

bun run build

リント

次のコマンドでバックエンドのコードをESLintでリントします。

bun run lint:write

Note

自動修正しない場合は次のコマンドを実行してください。

bun run lint

フォーマット

次のコマンドでバックエンドのコードをPrettierでフォーマットします。

bun run format:write

Note

フォーマットに従っているかの確認だけを行い、自動修正しない場合は次のコマンドを実行してください。

bun run format