saas starter kit

مجموعة Starter Starter Enterprise SaaS

Open Source Next.js SaaS Boilerplate لتطوير تطبيق Enterprise SaaS.

يرجى قيام بإعادة تدوين الريبو إذا كنت تريد منا الاستمرار في تطوير وتحسين مجموعة SaaS STARTER! ؟

موارد إضافية

فيديو - مجموعة SaaS Starter SaaS's: Ultimate Compliant Boilerplate
مدونة - طقم SaaS Starter جاهزة للمؤسسات

توفرك مجموعة SaaS Starter Kit المستندة إلى JS من خلال بدء تشغيل جميع الميزات المتماثلة في كل منتج ، بحيث يمكنك التركيز على ما يجعل تطبيقك فريدًا.

بنيت مع

• next.js هذا هو إطار React الذي يوفر ميزات مثل تقديم جانب الخادم وتوليد الموقع الثابت. يتم استخدامه لبناء واجهة المستخدم للتطبيق الخاص بك. يمكن العثور على التكوين الرئيسي لـ next.js في Next.config.js.
• Tailwind CSS هذا هو إطار عمل CSS الأول للمنفعة لبناء واجهات المستخدم المخصصة بسرعة. يتم استخدامه لتصميم التطبيق. يمكن العثور على تكوين CSS Tailwind في postcss.config.js.
• Postgres هذا هو نظام قاعدة بيانات الكائنات القوية المفتوحة المصدر. يتم استخدامه لتخزين بيانات التطبيق. من المحتمل أن تتم إدارة العلاقة مع Postgres من خلال Prisma.
• React This عبارة عن مكتبة JavaScript لبناء واجهات المستخدم. يتم استخدامه لإنشاء العناصر التفاعلية لتطبيقك. توجد مكونات React في دليل المكونات.
• PRISMA هذه هي مجموعة أدوات قاعدة بيانات مفتوحة المصدر. يتم استخدامه لرسم الخرائط العليا للكائنات ، مما يبسط عملية كتابة استعلامات قاعدة البيانات. يمكن العثور على تكوين PRISMA ومخططه في دليل PRISMA.
• TypeScript هذا هو superset المكتوبة من JavaScript التي تجمع إلى JavaScript العادي. يتم استخدامه لجعل الكود أكثر قوة وقابل للصيانة. يمكن العثور على تعريفات وتكوينات TypeScript في ملفات مثل Next-Env.d.ts و I18Next.d.ts.
• Saml Jackson (يوفر Saml SSO ، Sync Directory) هذه خدمة للتعامل مع SSSO SSO (علامة واحدة). يتم استخدامه للسماح للمستخدمين بتسجيل الدخول باستخدام معرف واحد وكلمة مرور إلى أي من الأنظمة العديدة ذات الصلة أي (باستخدام مجموعة واحدة من بيانات الاعتماد). يقع تطبيق SAML Jackson في المقام الأول داخل الملفات المرتبطة بالمصادقة.
• SVIX (يوفر WebHook Orchestration) هذه خدمة للتعامل مع Webhooks. يتم استخدامه لإبعاد الأحداث على عمليات المستخدم/الفريق ، والتي يمكن بعد ذلك القبض عليها والتعامل معها من قبل أجزاء أخرى من التطبيق أو الخدمات الخارجية. يتم توزيع تكامل SVIX في جميع أنحاء قاعدة الشرف ، في المقام الأول في المناطق التي يتم فيها تنفيذ عمليات إنشاء وقراءة وتحديث وحذف (CRUD).
• استرداد (يوفر خدمة سجلات التدقيق) هذه خدمة لتسجيل التدقيق ورؤية البيانات. يساعد على تتبع أنشطة المستخدم داخل التطبيق IE (من فعل ما ومتى في التطبيق). سيتم تفريق استخدام الاسترداد في جميع أنحاء قاعدة الكود ، على الأرجح في الملفات التي يتم فيها تنفيذ الإجراءات المهمة.
• Stripe (يوفر المدفوعات) هذه خدمة للتعامل مع المدفوعات. يتم استخدامه لمعالجة المدفوعات للتطبيق. من المحتمل أن يتم العثور على تكامل الشريط في الملفات المرتبطة بالفوترة والاشتراكات.
• الكاتب المسرحي (يوفر اختبارات E2E) هذه مكتبة Node.js لأتمتة المتصفحات. يتم استخدامه لتشغيل الاختبارات الشاملة على التطبيق. يمكن العثور على تكوين الكاتب المسرحي والاختبارات في دليل الاختبارات.
• DOCKER (يوفر DOCKER) هذا هو منصة لتطوير وتطبيقات وتشغيل التطبيقات. يتم استخدامه لتحميل التطبيق وتبعياته. يمكن العثور على تكوين Docker في Dockerfile و Docker-corm.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. إنشاء قاعدة بيانات (اختيارية)

لجعل عملية تثبيت التبعيات أسهل ، فإننا نقدم docker-compose.yml مع حاوية postgres.

docker-compose up -d

6. إعداد مخطط قاعدة البيانات

npx prisma db push

7. ابدأ الخادم

في بيئة التنمية:

npm run dev

8. ابدأ استوديو Prisma

Prisma Studio هو محرر مرئي للبيانات في قاعدة البيانات الخاصة بك.

npx prisma studio

9. الاختبار

نحن نستخدم الكاتب المسرحي لتنفيذ اختبارات E2E. إضافة جميع الاختبارات داخل مجلد /tests .

تحديث playwright.config.ts لتغيير تكوين الكاتب المسرحي.

تثبيت تبعيات الكاتب المسرحي

npm run playwright:update

تشغيل اختبارات E2E

npm run test:e2e

ملاحظة: يتم إنشاء تقرير اختبار HTML داخل مجلد report . متصفحات مدعومة حاليًا للاختبار تنفيذ chromium و firefox

BOALERPLATE القابلة للتخصيص بالكامل خارج المربع ، انظر الصور أدناه ؟؟؟

؟ سمات

• إنشاء حساب
• تسجيل الدخول بالبريد الإلكتروني وكلمة المرور
• تسجيل الدخول مع الرابط السحري
• تسجيل الدخول مع Saml SSO
• تسجيل الدخول مع Google [إعداد Google Oauth]
• تسجيل الدخول مع Github [إنشاء تطبيق GitHub Oauth]
• دليل المزامنة (SCIM)
• حساب التحديث
• إنشاء فريق
• حذف الفريق
• دعوة المستخدمين إلى الفريق
• إدارة أعضاء الفريق
• تحديث إعدادات الفريق
• Webhooks والأحداث
• تدويل
• سجلات التدقيق
• الأدوار والأذونات
• الوضع المظلم
• إشعارات البريد الإلكتروني
• اختبارات E2E
• Docker Compose
• PRISMA Studio
• تحديث دور العضو
• أحداث مزامنة الدليل
• تحميل الصورة الرمزية
• سام SSO
• سجل التدقيق
• webhook
• المدفوعات
• رؤوس الأمن

➡ قريبا

• الفواتير والاشتراكات
• اختبارات الوحدة والتكامل

المساهمة

شكرا لأخذ الوقت للمساهمة! المساهمات تجعل المجتمع مفتوح المصدر مكانًا رائعًا للتعلم والإلهام والخلق. أي مساهمات تقدمها موضع تقدير كبير.

يرجى محاولة إنشاء تقارير الأخطاء التي هي:

• قابلة للتكرار. تضمين خطوات لإعادة إنتاج المشكلة.
• محدد. قم بتضمين أكبر قدر ممكن من التفاصيل: أي إصدار ، ما هي البيئة ، إلخ.
• فريد. لا تكرر القضايا المفتوحة الحالية.
• تم تحديدها إلى خطأ واحد. خطأ واحد لكل تقرير.

دليل المساهمة

؟ مجتمع

• Discord (للمناقشة المباشرة مع مجتمع المصدر المفتوح وفريق BoxyHQ)
• Twitter / LinkedIn (تابعنا)
• يوتيوب (شاهد أحداث المجتمع والدروس التعليمية)
• قضايا جيثب (المساهمات ، قضايا التقارير ، وأفكار المنتج)

؟ المساهمين

صنعت مع contrib.rocks.

ترخيص؟

ترخيص Apache 2.0