kotohiro API Server

ことひろは意見や言葉を重ねて、よりよい意思決定を目指すサービスです。

🚀 開発環境

1. 前提パッケージのインストール

miseを用いてツールの管理をしています。

# macosの場合
brew install mise

# その他の環境
curl https://mise.run | sh

2. プロジェクトのセットアップ

リポジトリのクローン

git clone https://github.com/neko-dream/api.git
cd api

必要なツールのインストール

mise install

環境変数の設定

cp .env.example .env

3. コード生成

自動生成スクリプトを実行

./scripts/gen.sh

4. DBセットアップ

docker composeを使用します。 Docker Compose V2に対応したDockerをあらかじめインストールしてください、

docker compose up -d db

ユーザー名、パスワード、DB名は全てkotohiroです。

もしDockerを使用せず動かす場合は以下の要件を満たしたDBを使用してください。

• PostgreSQL 16
• PostGIS

5. ホットリロード

airを用いてホットリロードが可能

air

⚖️ License

ことひろ は GNU Affero General Public License v3.0 (AGPL-3.0) の下で提供されています。詳細についてはLICENSEをご確認ください。