Deploy to Squadbaseボタン

Deploy to Squadbaseボタンは、開発者が効率的な作成フローを通じてプロジェクトを迅速にデプロイできるツールです。リポジトリを自動的にクローンし、ワンクリックでアプリケーションをデプロイします。

スニペット

Deploy to Squadbaseボタンには、さまざまなURLクエリパラメータを追加することで、プロジェクトの要件に応じてユーザーのデプロイ体験を制御・カスタマイズできます。

上記はHTMLスニペットを使ったDeployボタンの例です。

以下のスニペットをGitリポジトリやダッシュボードに貼り付けて、ユーザーがデプロイできるようにしましょう。

[![Deploy to Squadbase](https://app.squadbase.dev/button.svg)](https://app.squadbase.dev/new/clone?repository-url=https://github.com/username/repo-name)

<a href="https://app.squadbase.dev/new/clone?repository-url=https://github.com/username/repo-name">
  <img src="https://app.squadbase.dev/button.svg" alt="Deploy to Squadbase" />
</a>

https://app.squadbase.dev/new/clone?repository-url=https://github.com/username/repo-name

https://github.com/username/repo-nameを実際のGitHubリポジトリURLに置き換えてください。

仕組み

ユーザーが「Deploy to Squadbase」ボタンをクリックすると：

1. リポジトリインポート: 指定されたリポジトリをユーザーのGithubにクローンします
2. 設定の検出: Squadbaseがプロジェクト設定を自動検出するか、squadbase.yml設定を使用します
3. 環境のセットアップ: 必要な環境変数の入力をユーザーに求めます
4. ビルド＆デプロイ: アプリケーションがビルドされ、Squadbase環境にデプロイされます

独自のデプロイボタンを生成する

カスタマイズされたデプロイボタンURLを作成するには、ベースURLにクエリパラメータを使用します：

https://app.squadbase.dev/new/clone?[パラメータ]

必須パラメータ

オプションパラメータ

複数パラメータの例

https://app.squadbase.dev/new/clone?repository-url=https://github.com/username/repo&project-name=my-app&env-var-keys=API_KEY,DATABASE_URL&subdomain=custom-domain

環境変数

env-var-keysパラメータを使用して環境変数を指定すると、デプロイプロセス中にユーザーは値の入力を求められます。

使用例

[![Deploy to Squadbase](https://app.squadbase.dev/button.svg)](https://app.squadbase.dev/new/clone?repository-url=https://github.com/username/repo)

[![Deploy to Squadbase](https://app.squadbase.dev/button.svg)](https://app.squadbase.dev/new/clone?repository-url=https://github.com/username/repo&env-var-keys=DATABASE_URL,API_KEY,SECRET_KEY)

必要な変数の文書化

プロジェクトで必要な環境変数について明確なドキュメントを含めてください：

## 環境変数

このプロジェクトには以下の環境変数が必要です：

- `DATABASE_URL` - PostgreSQLデータベース接続文字列
- `API_KEY` - あなたのAPIサービスキー
- `SECRET_KEY` - セッション管理用のアプリケーションシークレット

ベストプラクティス

READMEへの統合

プロジェクトのREADMEにデプロイ手順を含めてください：

## クイックデプロイ

ワンクリックでこのアプリケーションをSquadbaseにデプロイ：

[![Deploy to Squadbase](https://app.squadbase.dev/button.svg)](https://app.squadbase.dev/new/clone?repository-url=https://github.com/yourusername/yourrepo)

### 前提条件
- Node.js 18+が必要
- 必要な環境変数については`.env.example`を参照

設定のセットアップ

プロジェクトがデプロイ可能な状態であることを確認してください：

1. squadbase.ymlを含める カスタムビルド設定用
2. .env.exampleを提供する 必要な環境変数を示す
3. 依存関係を文書化する システム要件
4. ローカルでテストする デプロイボタンを追加する前に

モノレポサポート

モノレポの場合、アプリケーションディレクトリを指定してください：

https://app.squadbase.dev/new/clone?repository-url=https://github.com/username/monorepo&root-path=./apps/frontend