saas starter kit

Enterprise SaaSスターターキット

Open Source Next.JS SAASボイラープレートエンタープライズSAASアプリ開発のためのボイラープレート。

SaaSスターターキットの開発と改善を続けてほしい場合は、リポジトリに出演してください！ ？

追加のリソース

ビデオ-BoxyHQのSaaSスターターキット：究極のエンタープライズに準拠したボイラープレート
ブログ - エンタープライズ対応のSaaSスターターキット

Next.JSベースのSaaSスターターキットは、すべての製品で同じすべての機能を開始することで数ヶ月の開発を節約できます。そのため、アプリをユニークなものにすることに集中できます。

で構築されています

• next.jsこれは、サーバー側のレンダリングや静的サイト生成などの機能を提供するReactフレームワークです。アプリケーションのユーザーインターフェイスの構築に使用されます。 next.jsのメイン構成は、next.config.jsにあります。
• Tailwind CSSこれは、カスタムユーザーインターフェイスを迅速に構築するためのユーティリティファーストCSSフレームワークです。アプリケーションのスタイリングに使用されます。 Tailwind CSSの構成は、postcss.config.jsにあります。
• Postgresこれは、強力でオープンソースのオブジェクト関連データベースシステムです。アプリケーションデータの保存に使用されます。 Postgresへの接続は、Prismaを通じて管理される可能性があります。
• Reactこれは、ユーザーインターフェイスを構築するためのJavaScriptライブラリです。アプリケーションのインタラクティブな要素を作成するために使用されます。 Reactコンポーネントはコンポーネントディレクトリにあります。
• Prismaこれはオープンソースのデータベースツールキットです。オブジェクトリレーショナルマッピングに使用されており、データベースクエリの作成プロセスを簡素化します。 Prisma構成とスキーマは、Prismaディレクトリにあります。
• TypeScriptこれは、Plain JavaScriptにコンパイルするJavaScriptのタイプされたスーパーセットです。コードをより堅牢で保守可能にするために使用されます。タイプスクリプトの定義と構成は、Next-env.d.tsやi18next.d.tsなどのファイルにあります。
• Saml Jackson（SAML SSO、Directory Syncを提供）これは、SAML SSO（シングルサインオン）を処理するためのサービスです。これは、ユーザーがいくつかの関連システムのいずれかに単一のIDとパスワードでサインインできるようにするために使用されます（単一の資格情報セットを使用）。 Saml Jacksonの実装は、主に認証に関連付けられたファイル内にあります。
• svix（Webhookオーケストレーションを提供）これは、Webhookを処理するためのサービスです。ユーザー/チームのCRUD操作のイベントを放出するために使用されます。これは、アプリケーションまたは外部サービスの他の部分によってキャッチおよび処理できます。 SVIXの統合は、主に作成、読み取り、更新、および削除（CRUD）操作が実行される領域で、コードベース全体に分布しています。
• Retraced（監査ログサービスの提供）これは、監査記録とデータの可視性のためのサービスです。アプリケーション内のユーザーアクティビティを追跡するのに役立ちます（アプリケーションで何をしたか）。リタクトの使用は、重要なアクションが実行されるファイルでは、コードベース全体に分散されます。
• Stripe（支払いを提供）これは支払いを処理するためのサービスです。アプリケーションの支払いを処理するために使用されます。ストライプの統合は、請求とサブスクリプションに関連付けられたファイルに見られる可能性があります。
• Playwright（E2Eテストを提供）これは、ブラウザを自動化するためのnode.jsライブラリです。アプリケーションでエンドツーエンドテストを実行するために使用されます。劇作家の構成とテストは、テストディレクトリにあります。
• Docker（Docker Composeを提供）これは、アプリケーションを開発、出荷、および実行するためのプラットフォームです。アプリケーションとその依存関係を容易にするために使用されます。 Docker構成は、DockerFileおよびDocker-Compose.ymlにあります。
• nextauth.js（認証を提供）これは、next.jsアプリケーション向けの完全なオープンソース認証ソリューションです。ユーザー認証と承認を処理するために使用されます。 nextauth.js構成とプロバイダーは、ページ/API/auth/[... nextauth] .tsファイルにあります。

展開

はじめる

これらの簡単な手順に従って、ローカルコピーを稼働させてください。

前提条件

• node.js（バージョン：> = 18.x）
• postgreSql
• npm
• Dockerは作曲します

発達

1。セットアップ

• リポジトリをフォークします
• このコマンドを使用してリポジトリをクローンします。

git clone https://github.com/ < your_github_username > /saas-starter-kit.git

2。プロジェクトフォルダーに移動します

 cd saas-starter-kit

3.依存関係をインストールします

npm install

4. .ENVファイルを設定します

duplicate .env.example to .env 。

cp .env.example .env

5.データベースを作成する（オプション）

依存関係のインストールを簡単にするために、Postgresコンテナを備えたdocker-compose.ymlを提供します。

docker-compose up -d

6.データベーススキーマを設定します

npx prisma db push

7.サーバーを起動します

開発環境で：

npm run dev

8。Prisma Studioを開始します

Prisma Studioは、データベースのデータの視覚エディターです。

npx prisma studio

9。テスト

Playwrightを使用してE2Eテストを実行しています。 /testsフォルダー内にすべてのテストを追加します。

playwright.config.tsを更新して、劇作家構成を変更します。

劇作家の依存関係をインストールします

npm run playwright:update

E2Eテストを実行します

npm run test:e2e

注：HTMLテストレポートは、 reportフォルダー内で生成されます。現在、テスト実行chromiumとfirefoxためにサポートされているブラウザ

箱から出して完全にカスタマイズ可能なボイラープレート、下の画像を参照してください???

？特徴

• アカウントを作成する
• 電子メールとパスワードでサインインします
• マジックリンクでサインインします
• SAML SSOでサインインします
• Googleにサインイン[GoogleOuthのセットアップ]
• githubでサインイン[Github Oauthアプリの作成]
• ディレクトリシンク（SCIM）
• アカウントを更新します
• チームを作成します
• チームを削除します
• ユーザーをチームに招待します
• チームメンバーを管理します
• チーム設定を更新します
• webhooks＆events
• 国際化
• 監査ログ
• 役割と権限
• ダークモード
• 電子メール通知
• E2Eテスト
• Dockerは作曲します
• プリスマスタジオ
• メンバーの役割を更新します
• ディレクトリ同期イベント
• アバターアップロード
• SAML SSO
• 監査ログ
• webhook
• 支払い
• セキュリティヘッダー

doがすぐに来ます

• 請求とサブスクリプション
• ユニットと統合テスト

貢献

貢献するために時間を割いてくれてありがとう！貢献により、オープンソースコミュニティは、学習、インスピレーション、および作成する素晴らしい場所になります。あなたがする貢献はどんな貢献も大歓迎です。

次のバグレポートを作成してみてください。

• 再現可能。問題を再現するための手順を含めます。
• 特定の。できるだけ多くの詳細を含めます：どのバージョン、どの環境など。
• 個性的。既存の開かれた問題を複製しないでください。
• 単一のバグにスコープ。レポートごとに1つのバグ。

寄稿ガイド

？コミュニティ

• Discord（オープンソースコミュニティおよびBoxyHQチームとのライブディスカッションのため）
• Twitter / LinkedIn（フォローしてください）
• YouTube（コミュニティイベントやチュートリアルを見る）
• GitHubの問題（貢献、レポートの問題、および製品のアイデア）

？貢献者

contrib.rocksで作られています。

？§ライセンス

Apache 2.0ライセンス