saas starter kit

엔터프라이즈 SaaS 스타터 키트

오픈 소스 Next.js SaaS Boilerplate Enterprise SaaS 앱 개발.

SaaS 스타터 키트를 계속 개발하고 개선하기를 원한다면 저장소에 출연하십시오! ?

추가 리소스

비디오 -Boxyhq 's SaaS 스타터 키트 : 궁극적 인 엔터프라이즈 호환 보일러 플레이트
블로그 - 엔터프라이즈 준비된 SaaS 스타터 키트

JS에 기반을 둔 SaaS 스타터 키트는 모든 제품에서 동일한 모든 기능을 시작하여 수개월의 개발을 절약하므로 앱을 독특하게 만드는 것에 집중할 수 있습니다.

구축

• 다음 .js 서버 측 렌더링 및 정적 사이트 생성과 같은 기능을 제공하는 React 프레임 워크입니다. 응용 프로그램의 사용자 인터페이스를 구축하는 데 사용됩니다. Next.js의 기본 구성은 Next.config.js에서 찾을 수 있습니다.
• Tailwind CSS 이것은 사용자 정의 사용자 인터페이스를 신속하게 구축하기위한 유틸리티 우선 CSS 프레임 워크입니다. 응용 프로그램 스타일링에 사용됩니다. Tailwind CSS 구성은 Postcss.config.js에서 찾을 수 있습니다.
• Postgres 이것은 강력한 오픈 소스 객체 관계 데이터베이스 시스템입니다. 응용 프로그램 데이터를 저장하는 데 사용됩니다. Postgre와의 연결은 Prisma를 통해 관리 될 수 있습니다.
• 반응 사용자 인터페이스를 구축하기위한 JavaScript 라이브러리입니다. 응용 프로그램의 대화식 요소를 작성하는 데 사용됩니다. React 구성 요소는 구성 요소 디렉토리에 있습니다.
• PRISMA 이것은 오픈 소스 데이터베이스 툴킷입니다. 객체 관계 매핑에 사용되며 데이터베이스 쿼리를 작성하는 프로세스를 단순화합니다. Prisma 구성 및 스키마는 Prisma 디렉토리에서 찾을 수 있습니다.
• TypeScript 이것은 평범한 JavaScript로 컴파일하는 JavaScript의 입력 된 슈퍼 세트입니다. 코드를보다 강력하고 유지 관리 할 수 있도록하는 데 사용됩니다. TypeScript 정의 및 구성은 Next-Env.d.ts 및 i18next.d.ts와 같은 파일에서 찾을 수 있습니다.
• Saml Jackson (SAML SSO 제공, 디렉토리 동기화) SAML SSO (단일 사인온)를 처리하는 서비스입니다. 사용자가 여러 관련 시스템 (즉, 단일 자격 증명 세트 사용)에 단일 ID 및 비밀번호로 로그인 할 수 있습니다. Saml Jackson의 구현은 주로 인증과 관련된 파일 내에 있습니다.
• SVIX (Webhook Orchestration 제공) WebHooks를 처리하는 서비스입니다. 사용자/팀 CRUD 운영에서 이벤트를 방출하는 데 사용되며 응용 프로그램 또는 외부 서비스의 다른 부분에서 잡고 처리 할 수 있습니다. SVIX의 통합은 주로 CRUD (Cread, Read, Update 및 Delete) 작업이 실행되는 영역에 코드베이스 전체에 배포됩니다.
• 반복 (감사 로그 서비스 제공) 감사 기록 및 데이터 가시성을위한 서비스입니다. 응용 프로그램 IE (응용 프로그램에서 무엇을 수행했는지) 내에서 사용자 활동을 추적하는 데 도움이됩니다. 반복의 사용은 코드베이스 전체에 분산 될 수 있으며, 중요한 조치가 수행되는 파일에서 가능합니다.
• Stripe (지불 제공) 이것은 지불을 처리하기위한 서비스입니다. 응용 프로그램에 대한 지불을 처리하는 데 사용됩니다. Stripe의 통합은 청구 및 구독과 관련된 파일에서 발견 될 수 있습니다.
• 극작가 (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 Compose

개발

1. 설정

• 저장소를 포크하십시오
• 이 명령을 사용하여 저장소를 복제하십시오.

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

2. 프로젝트 폴더로 이동하십시오

 cd saas-starter-kit

3. 종속성을 설치하십시오

npm install

4. .env 파일을 설정하십시오

.env.example .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는 데이터베이스의 데이터에 대한 시각적 편집기입니다.

npx prisma studio

9. 테스트

우리는 극작가를 사용하여 E2E 테스트를 실행하고 있습니다. /tests 폴더 내부에 모든 테스트를 추가하십시오.

극작가 구성을 변경하려면 playwright.config.ts 업데이트하십시오.

극작가 종속성을 설치하십시오

npm run playwright:update

E2E 테스트를 실행하십시오

npm run test:e2e

참고 : HTML 테스트 보고서는 report 폴더 내부에서 생성됩니다. 현재 테스트 실행 chromium 및 firefox 브라우저가 지원됩니다

완전히 사용자 정의 할 수있는 보일러 플레이트는 상자에서 아래 이미지를 참조하십시오 ???

? 특징

• 계정을 만듭니다
• 이메일과 비밀번호로 로그인하십시오
• Magic Link로 로그인하십시오
• SAML SSO로 로그인하십시오
• Google에 로그인 [Google Oauth 설정]
• Github로 로그인 [Github Oauth 앱 생성]
• 디렉토리 동기화 (SCIM)
• 업데이트 계정
• 팀을 만듭니다
• 삭제 팀
• 사용자를 팀에 초대하십시오
• 팀원을 관리합니다
• 팀 설정을 업데이트합니다
• Webhooks & Events
• 국제화
• 감사 로그
• 역할 및 권한
• 다크 모드
• 이메일 알림
• E2E 테스트
• Docker Compose
• 프리즘 스튜디오
• 멤버 역할 업데이트
• 디렉토리 동기화 이벤트
• 아바타 업로드
• SAML SSO
• 감사 로그
• Webhook
• 지불
• 보안 헤더

➡️ 곧 올 것입니다

• 청구 및 구독
• 단위 및 통합 테스트

기여

시간을내어 공헌 해 주셔서 감사합니다! 기고는 오픈 소스 커뮤니티를 배우고, 영감을주고, 창조 할 수있는 환상적인 장소로 만듭니다. 당신이하는 모든 기여는 대단히 감사합니다.

다음과 같은 버그 보고서를 작성하십시오.

• 재생할 수 있는. 문제를 재현하는 단계를 포함하십시오.
• 특정한. 가능한 많은 세부 사항을 포함시킵니다. 어떤 버전, 환경 등.
• 고유한. 기존 열린 문제를 복제하지 마십시오.
• 단일 버그로 범위를 지정했습니다. 보고서 당 하나의 버그.

기고 가이드

? 지역 사회

• Discord (오픈 소스 커뮤니티 및 Boxyhq 팀과의 라이브 토론)
• Twitter / LinkedIn (팔로우)
• YouTube (커뮤니티 이벤트 및 튜토리얼보기)
• GitHub 문제 (기여, 보고서 문제 및 제품 아이디어)

? 기고자

Contrib.rocks로 만들어졌습니다.

? ️ 라이센스

Apache 2.0 라이센스