Skip to content

peno022/kpi-tree-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

153 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KPI ツリーメーカー

logo

サービス概要

KPI ツリーメーカーを使うと、数クリックですぐに KPI ツリー図を作成し、画像でダウンロードすることができます。
KPI ツリーに特化したツールのため、Excel 等を利用するよりも簡単に、ツリー内の KPI を調整できることが特徴です。

URL

https://kpi-tree.com/

サービス利用の流れ

  1. Google アカウントでサインアップする

  2. ツリーを新規作成する

  3. ツリー要素の追加や編集を行う

  4. 作成したツリー画像はダウンロードできます

利用技術

言語

  • Ruby 3.1
  • TypeScript

フレームワーク

  • Ruby on Rails 7.0
  • React
  • Tailwind CSS
  • daisyUI

その他ツール・ライブラリ

データベース

  • PostgreSQL 15.3

ホスティング

開発手順

ローカルコンテナ起動・開発方法

  1. リポジトリを clone する。

    $ git clone https://github.com/peno022/kpi-tree-generator.git
  2. プロジェクトルート直下に移動して、コンテナ起動コマンドを実行する。

    # make up を実行すると、コンテナをビルドして docker compose 環境が起動します
    $ cd kpi-tree-generator
    $ make up
  3. ローカルコンテナに接続し、開発準備用のコマンドを実行する。

    # コンテナの中に入る
    $ make login
    
    # DB 等のセットアップ
    $ bin/setup
    
    # rails server の起動
    $ bin/dev
    # => ブラウザから http://localhost:3000 を開くと、アプリケーションにアクセスできます
  4. 開発する。

  • ソースコードを修正した場合、ローカル開発画面を更新すれば変更が反映されます。
  • gem を追加した場合などは、コンテナの再ビルドが必要になる可能性があります。
  1. (任意) コンテナを再ビルドする。

    # (ローカル環境にて) コンテナの停止
    $ make down
    
    # コンテナの再ビルド
    $ make build
    
    # コンテナ起動
    $ make up
    
    # 手順 4 へ
  2. lint/format を実行する。

    # (コンテナ内で)
    $ bin/lint
  • 実行される lint/format は下記になります。
    • Ruby
      • rubocop
      • slim-lint
    • JavaScript
      • eslint
      • prettier
  1. テストを実行する。

    # (コンテナ内で)
    # Railsのモデル・リクエスト・システムテスト
    $ bundle exec rspec
    
    # TypeScriptモジュール・Reactコンポーネントのテスト
    $ yarn jest

開発終了

  1. コンテナを停止する。

    # コンテナ終了
    $ make down

デプロイ

  • 現状、peno022 のみデプロイ作業実施可能です。
  1. 開発した内容を feature ブランチにプッシュする。

    $ git add xxx
    $ git commit -m xxx
    $ git push origin feature/example
  2. main ブランチに向けて PR を作成する。

  3. approve 後、main ブランチにマージする。

  4. main ブランチにマージされると、GitHub Actions によって Fly.io の環境にデプロイされる。

About

No description, website, or topics provided.

Resources

License

Stars

4 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors