Squadbase logo

Project

Squadbaseでのプロジェクト管理

Projectとは

Projectは、アプリケーション開発の中心となる機能です。コードの管理、デプロイメント、実行環境の設定、アクセス分析、ログ確認などを統合的に管理できます。

主な特徴

  • 統合的な管理: コード、デプロイ、ログ、分析を一元管理
  • スペースとの連携: 必ずスペースに所属し、スペースメンバーと権限を共有
  • 複数の作成方法: テンプレート、GitHubインポート、ファイルアップロードから選択可能
  • 環境管理: Production(本番)とPreview(プレビュー)環境を使い分け
  • フィードバック収集: チーム内でのコメント・フィードバック機能

プロジェクトの作成

すべてのプロジェクトはスペースに所属する必要があります。スペースメンバーは自動的にそのスペース内のすべてのプロジェクトにアクセスできます。

スペース詳細画面で「Create Project」をクリック

スペース一覧からスペースを選択し、スペース詳細画面のヘッダーにある**「Create Project」**ボタンをクリックします。

所属するスペースを選択

「Space」ドロップダウンで、プロジェクトを作成するスペースを変更することができます。

プロジェクトは必ずスペースに所属し、チーム協業を可能にします。

作成方法を選択

以下3つの作成方法から選択できます(詳細は下記参照):

  • Excel、CSV、Jupyter Notebookファイルのアップロード
  • テンプレートから開始する
  • GitHubからリポジトリをインポートする

作成方法の種類

Excel、CSV、Jupyter Notebookファイルをアップロード

データファイルからダッシュボードを作成します。アップロード後、エディターが開き、データの可視化やインタラクティブなダッシュボード構築が可能です。

対応形式:

  • Excel (.xlsx, .xls)
  • CSV (.csv)
  • Jupyter Notebook (.ipynb)

手順:

  1. 「Upload File」タブを選択
  2. ファイルをアップロード
  3. 処理完了後、エディターで編集

テンプレートから作成

さまざまなフレームワークやユースケースに対応したテンプレートで素早く開始できます。

利用可能なテンプレート:

  • Streamlitアプリケーション
  • FastAPI
  • Next.js
  • その他のフレームワーク

手順:

  1. 「Start from Template」タブを選択
  2. 使用したいテンプレートを選択
  3. プロジェクトが作成されます

GitHubリポジトリからインポート

既存のGitHubリポジトリをインポートしてプロジェクトを作成します。

前提条件:

  • GitHubアカウントの連携が必要
  • 対象リポジトリへのアクセス権限

手順:

  1. 「Import from GitHub Repository」タブを選択
  2. GitHub Organizationを選択
  3. インポートするリポジトリを選択
  4. プロジェクトが作成されます

メンバーアクセスについて

プロジェクト作成時、以下のアクセスルールが適用されます:

  • Automatic Access(自動アクセス): スペースメンバー全員が自動的にプロジェクトにアクセス可能
  • Permission Level(権限レベル): Organization Role(Admin、Creator、Viewer)に基づいてアクセスレベルが決定
  • Additional Members(追加メンバー): プロジェクト作成後、スペース外のメンバーも個別に招待可能

プロジェクトの表示と管理

プロジェクト一覧

スペース詳細画面にプロジェクトがカード形式で表示されます。

各カードの表示内容:

  • プレビュー画像: プロジェクトのスクリーンショット
  • プロジェクト名: プロジェクトの名称
  • 最終更新時刻: "Last updated XX ago" 形式で表示
  • Open App ボタン: デプロイ済みアプリケーションを開く
    • デプロイされていない場合はグレーアウト(無効)
  • Open Editor ボタン: エディターを開く

ピン留め機能

よく使うプロジェクトをサイドバーにピン留めできます。

ピン留めの方法:

  1. プロジェクトカードの 「...」 ボタンをクリック
  2. 「Pin project」を選択

効果:

  • サイドバーに「Pinned」セクションが表示されます
  • ピン留めしたプロジェクトが常に表示され、素早くアクセスできます

ピン留め解除:

  • 同じメニューから「Unpin project」を選択

プロジェクト詳細画面

プロジェクト名をクリックすると、詳細画面が表示されます。

ヘッダー部分

  • メンバーアバター: アクセス権を持つメンバーのアイコンが表示されます
  • Open App: デプロイ済みアプリを開く
  • Open Editor: コードエディタを開く
  • タブナビゲーション: 6つのタブで機能を切り替え

Projectタブ

プロジェクトの概要と最新情報を表示します。

Latest Deployment(最新デプロイメント)

最新のデプロイメント状況を確認できます。

表示項目:

  • ステータス: Ready(準備完了)、Errorなど
  • Environment: Production、Previewなどの環境
  • コミットハッシュ: デプロイされたコードのバージョン
  • Current バッジ: 現在公開中のデプロイメント
  • コミットメッセージ: 変更内容の説明
  • デプロイ時刻と実行者: いつ、誰がデプロイしたか

User Analytics(ユーザー分析)

アプリケーションへのアクセス状況を分析できます。

機能:

  • 期間選択: Weekly(週次)などで期間を選択
  • Page Views グラフ: 日別のアクセス数を視覚化

詳細はAnalytics機能を参照してください。

Comments(コメント・フィードバック)

チーム内でフィードバックを収集できます。

カテゴリ:

  • ✨ Feedback: 一般的なフィードバック・使用感
  • 🐞 Bug Report: バグ・不具合の報告
  • 💡 Feature Request: 新機能の提案
  • 💬 Question: 質問・確認事項
  • ✍️ Note: メモ・ドキュメント

操作:

  • 「New Comment」ボタンから新規コメントを作成

デプロイメント管理

Deploymentsタブ

プロジェクトのデプロイメント履歴を管理します。

画面構成:

  • Environment絞り込み: "All Environments"または特定環境で絞り込み
  • Create Deployment +: 新規デプロイメントを作成
  • デプロイメント一覧: テーブル形式で表示

一覧の表示内容:

項目説明
コミットハッシュデプロイされたコードのバージョン
Current バッジ現在公開中のデプロイメント
EnvironmentProduction、Previewなど
ステータスReady、Errorなど
デプロイ時間ビルド時間 + 経過時間
コミットメッセージ変更内容の説明
デプロイ日時デプロイが実行された日時
デプロイ実行者デプロイを実行したユーザー
View Detailsデプロイメントの詳細を表示

操作:

  • View Details: デプロイメントの詳細を確認
  • ページネーション: 複数ページにわたる履歴を閲覧

メンバー管理

Membersタブ

プロジェクトメンバーとその権限を管理します。

画面構成:

  • Invite Member ボタン: 新規メンバーを招待
  • Project Role 説明: プロジェクトロールに関する情報
  • メンバー一覧: 2つのセクションに分かれて表示

Organization Admins(組織管理者)

組織レベルの管理者が表示されます。

表示内容:

  • アバター
  • ユーザー名
  • Organization Role: Admin
  • "Full access to all projects" 表示
  • "Full Control" バッジ

特徴:

  • 全プロジェクトへのフルアクセス権を持つ
  • 個別の招待は不要

Space Members(スペースメンバー)

スペース経由でプロジェクトにアクセスしているメンバー。

表示内容:

  • アバター
  • ユーザー名
  • Organization Role: Creator、Viewer
  • "via Space: [スペース名]" 表示
  • アクセスレベル:
    • Deploy & View: デプロイと閲覧が可能(Creator)
    • View Only: 閲覧のみ可能(Viewer)
  • アクションメニュー(...)

特徴:

  • スペースメンバーであれば自動的にアクセス可能
  • 権限はOrganization Roleに基づく

プロジェクト設定

Settingsタブ

プロジェクトの詳細設定を管理します。

サイドバーメニュー:

  • Overview(概要)
  • Git Repository(Gitリポジトリ)
  • Database(データベース)
  • Environments(環境設定)
    • Production
    • Preview

Overview Settings(概要設定)

プロジェクトの基本情報を編集できます。

編集可能な項目:

  • Project Name: プロジェクト名を変更
  • Space: 所属するスペースを変更
  • Save ボタン: 変更を保存

読み取り専用の情報:

  • Project ID: プロジェクトの一意な識別子(コピー可能)
  • Outbound IPs: プロジェクトからの送信元IPアドレス一覧(コピー可能)
    • データベースやAPIの接続許可設定に使用

Danger Zone(危険な操作)

重要な変更や削除操作を行うセクションです。

Make Project Public(プロジェクトを公開)

  • 現在の状態: "This project is currently private."
  • 「Change Visibility」ボタンで公開設定を変更

Delete Project(プロジェクト削除)

この操作は取り消せません! 削除すると、すべてのデプロイメント、ログ、設定が完全に失われます。

  • 説明: "You can delete the project. This action is irreversible."(この操作は取り消せません)
  • 「Delete Project」ボタンで削除

Tips & よくある質問

Q: プロジェクトとスペースの関係は?

A: プロジェクトは必ずスペースに所属します。スペースメンバーは自動的に全プロジェクトにアクセスできるため、チームでの作業が簡単です。

Q: GitHubリポジトリを後から変更できますか?

A: はい、Settings > Git Repository から変更できます。

Q: デプロイメントを作成するには?

A: Deploymentsタブの「Create Deployment +」ボタン、またはエディターからデプロイできます。

Q: プロジェクトメンバーを個別に追加するには?

A: Membersタブの「Invite Member」ボタンから、スペース外のメンバーも招待できます。

Q: Outbound IPsは何に使いますか?

A: 外部データベースやAPIサービスへの接続時、ファイアウォールやアクセス制限の設定で使用します。これらのIPアドレスからの接続を許可する必要があります。

Q: ProductionとPreview環境の違いは?

A: Production は本番環境、Previewはテスト・プレビュー用です。詳細はEnvironment機能を参照してください。

おすすめの使い方

  1. テンプレートから始める: 初めてのプロジェクトは、テンプレートから始めるとスムーズです
  2. ピン留めを活用: よく使うプロジェクトをピン留めして、アクセスを高速化しましょう
  3. Comments機能でコラボレーション: バグ報告や機能要望をComments機能で共有し、チームでの情報共有を促進
  4. デプロイメント履歴を確認: 問題が発生した場合、Deploymentsタブで履歴を確認し、いつから問題が起きたか特定できます
  5. ログを活用: 問題の原因を特定するために、ログ機能を積極的に活用しましょう

まとめ

Projectは、アプリケーション開発の中心となる強力な機能です。作成から管理、デプロイ、分析まで、すべてを一元的に行えます。スペースと連携することで、チームでの効率的な開発が実現します。

主要な機能:

  • 統合的なプロジェクト管理
  • 柔軟なデプロイメント管理
  • チームコラボレーション
  • 詳細なアクセス制御
  • ユーザー分析とログ監視

さらに詳しい情報は、各機能の専用ドキュメント(AnalyticsEnvironmentLogsなど)をご参照ください。