تنزيل node starter kit - تنزيل رمز مصدر node starter kit .

node starter kit

بيانات الموقع

1.0.0

تنزيل

Node.js API Starter Kit

Node.js API Starter Kit هي قالب مشروع لبناء Node.js تطبيقات الواجهة الخلفية المحسنة للبنية التحتية بدون خادم مثل وظائف السحابة من Google ، و AWS lambda ، ووظائف Azure ، وما إلى ذلك.

سمات

قاعدة بيانات التصميم الأول ؛ نماذج البيانات المكتوبة بقوة (TypeScript) التي تم إنشاؤها تلقائيًا (TypeScript)
المصادقة والترخيص باستخدام مزودي OAUTH 2.0 (Google ، Facebook ، Github ، إلخ)
جلسات عديمة الجنسية تم تنفيذها مع الرموز JWT وملف تعريف ارتباط الجلسة (متوافقة مع SSR)
مثال API GraphQL ، تم تنفيذه باستخدام نهج تطوير الكود الأول
ترحيل مخطط قاعدة البيانات والبذور وأدوات قذيفة
رسائل البريد الإلكتروني للمعاملات باستخدام قوالب المقابض ومعاينات البريد الإلكتروني الفوري
سجلات منظمة وتقارير خطأ إلى Google StackDriver
أدوات اختبار الوحدة المكوّنة مسبقًا مدعومة من الدعاوى والخارق
تجميع التطبيق مع Rollup كأسلوب تحسين للنشر بدون خادم
يعيد بناء التطبيق وإعادة تشغيله على التغييرات عند التشغيل محليًا
تم تكوينه مسبقًا لبيئات local ، dev ، test ، و prod
يتم دعم التصميم والتطوير المستمر من قبل هذه الشركات الرائعة:

تم الحصول على هذا المشروع مع مجموعة Node.js API Starter Kit. تأكد من الانضمام إلى قناة Discord للحصول على المساعدة.

مكدس التكنولوجيا

Node.js V14 ، مدير حزمة الغزل ، TypeScript ، Babel ، Rollup ، Eslint ، أجمل ، Jest
postgresql ، graphql.js ، Knex ، Express ، Nodemailer ، قوالب البريد الإلكتروني ، المقاود ، OAUTH2 البسيطة

هيكل الدليل

├── .build - الإخراج المترجمة والمجمعة (لكل وظيفة سحابة)
├── .vscode - إعدادات VScode بما في ذلك قصاصات التعليمات البرمجية ، الامتدادات الموصى بها وما إلى ذلك.
├── api - وظيفة السحابة لمعالجة طلبات API باستخدام GraphQL.JS
├── auth - المصادقة والوسائط الوسيطة الجلسة
├── core - وحدات التطبيق الشائعة (البريد الإلكتروني ، التسجيل ، إلخ)
├── db - عميل قاعدة البيانات لـ postgreSQL باستخدام Knex
├── emails - قوالب البريد الإلكتروني لرسائل البريد الإلكتروني للمعاملات باستخدام المقاود
├── env - متغيرات البيئة local ، dev ، test ، و prod
├── migrations - ترحيل مخطط قاعدة البيانات (Cloud SQL ، Knex)
├── scripts - البرامج النصية للنشر ، REPL SHELL ، إلخ.
├── test - اختبارات الوحدة والمعايير
├── views - قوالب HTML باستخدام المقاود
└── ... - إضافة المزيد من وظائف السحابة مثل worker ، notifications ، إلخ.

متطلبات

Node.js V14 ، مدير حزمة الغزل
مثيل محلي أو بعيد من postgreSQL (انظر postgres.app ، Google Cloud SQL)
VS Code Editor مع امتدادات موصى بها

ابدء

استنساخ repo- git clone -o seed https://github.com/kriasoft/node-starter-kit.git .
تحديث متغيرات البيئة لبيئات local ، dev ، test ، و prod ( ./env ).
تثبيت تبعيات المشروع - yarn install
قاعدة بيانات postgresql bootstrap - yarn db:create
أخيرًا ، قم بتشغيل التطبيق - yarn start ، سيصبح متاحًا على http: // localhost: 8080.

استخدم متغير APP_ENV Environment لتنفيذ البرامج النصية لبيئات مختلفة ، على سبيل المثال:

 $ APP_ENV=test yarn db:migrate
$ APP_ENV=test yarn start

هام : تأكد من أن VSCODE يستخدم إصدارات مساحة العمل من TypeScript و ESLINT.

البرامج النصية

yarn start - يطلق التطبيق في وضع التطوير على http://localhost:8080
yarn build - يجمع وتجمع التطبيق للنشر
yarn lint - التحقق من صحة الكود باستخدام ESLINT
yarn tsc - التحقق من صحة الكود باستخدام برنامج التحويل البرمجي typescript
yarn test - اختبارات وحدة التشغيل مع Jest ، اختبار عظم
yarn repl - اتصل بقاعدة البيانات باستخدام قذيفة Knex REPL
yarn psql - اتصل بقاعدة البيانات باستخدام postgresql cli
yarn db:create - إنشاء قاعدة بيانات جديدة
yarn db:version - تحقق من الإصدار الحالي من قاعدة البيانات
yarn db:migrate - Migrate Database Schema إلى أحدث إصدار
yarn db:rollback - الترحيل الأخير
yarn db:seed قاعدة بيانات البذور مع بيانات عينة / مرجعية
yarn db:reset -إعادة تطبيق أحدث ملف ترحيل مخطط DB
yarn update-types قم بإنشاء نماذج بيانات مكتوبة بقوة من مخطط قاعدة البيانات

اختياريًا قم بتعيين APP_ENV على local (الافتراضي) أو dev أو test أو prod قبل تشغيل هذه البرامج النصية.

كيفية تكوين تدفق تسجيل الدخول 0auth 2.0

لكل مزود هوية طرف ثالث يحتاج إلى تمكين تطبيقك ، ستحتاج إلى الحصول على بيانات اعتماد التطبيق ، وغالبًا ما تسمى معرف العميل/السر.

جوجل

انتقل إلى Google Cloud Console
إنشاء مشروع GCP جديد
تكوين شاشة متحدة المركز OAUTH
إنشاء عميل OAUTH 2.0 مع http://localhost/auth/google/return كعنوان URL رد الاتصال
تحديث GOOGLE_CLIENT_ID ، GOOGLE_CLIENT_SECRET البيئة المتغيرات الموجودة في ./env/.env.* لكل بيئة تحتاجها.

من هناك فصاعدًا ، فإن زيارة http://localhost:8080/auth/google (أو ، فتحه في نافذة منبثقة) سيبدأ تدفق تسجيل الدخول عبر Google.

فيسبوك

انتقل إلى موقع مطور Facebook
قم بإنشاء تطبيق Facebook جديد ، قم بتمكين تسجيل الدخول إلى Facebook لهذا التطبيق
أغلق حوار QuickStart وانتقل مباشرة إلى إعدادات التطبيق
أضف http://localhost/auth/facebook/return باعتباره عنوان URL للاتصال لتدفق تسجيل الدخول
انسخ ولصق معرف تطبيق Facebook الذي تم إنشاؤه حديثًا إلى FACEBOOK_APP_ID ، FACEBOOK_APP_SECRET المتغيرات الموجودة في ملفات env/.env.* لكل بيئة تحتاجها.

من هناك فصاعدًا ، فإن زيارة http://localhost:8080/auth/facebook (أو ، فتحه في نافذة منبثقة) سيبدأ تدفق تسجيل الدخول عبر Facebook.

كيفية النشر

يعتمد البرنامج النصي للنشر ( yarn deploy ) على أداة Google Cloud CLI ( gcloud ) التي يمكنك تنزيلها من هنا. بالنسبة لسير عمل CI/CD ، قد تحتاج إلى صورة Docker مثل هذه.

gcloud auth login - تفويض أداة Google Cloud SDK (CLI) لاستخدام حساب Google الخاص بك.

قم بإنشاء مشروع GCP جديد لتطبيقك مع معرفات مثل example للإنتاج ، example-test على بيئات الاختبار / ضمان الجودة. تأكد من تمكين واجهة برمجة تطبيقات Cloud Build و Cloud Functions في إعدادات مشروع GCP هنا.

قم بإنشاء مثيل قاعدة بيانات Cloud SQL هنا في نفس المنطقة حيث يجب نشر تطبيقك. يجب أن يكون استخدام مثيل صغير من Cloud SQL مع ذاكرة وصول عشوائي 0.6 جيجابايت على ما يرام للاختبار ومواقع المرور المنخفضة.

تأكد من أن GOOGLE_CLOUD_PROJECT و GOOGLE_CLOUD_REGION و PGDATABASE و PGUSER ومتغيرات البيئة الأخرى يتم تعيينها بشكل صحيح لبيئة النشر الهدف (eg /env/.env + /env/.env.prod للإنتاج).

أخيرًا ، قم بتجميع التطبيق ونشره عن طريق التشغيل:

yarn build - يجمع التطبيق في مجلد .build
APP_ENV=<env> yarn db:migrate - Migrates Database (Schema) إلى أحدث إصدار
APP_ENV=<env> yarn deploy - ينشر التطبيق على وظائف Google Cloud (GCF)

حيث <env> هي البيئة المستهدفة ، على سبيل المثال APP_ENV=prod yarn deploy .

كيفية التحديث

yarn set version latest - خيوط عثرة إلى أحدث إصدار
yarn upgrade-interactive وحدات تحديث Node.js (تبعيات)
yarn pnpify --sdk vscode -تحديث TypeScript و ESLINT و ALTTIER في VSCODE

مؤيدون

المشاريع ذات الصلة

GraphQL API Starter Kit-قالب Monorepo ، تم تكوينه مسبقًا مع TypeScript و GraphQL و React و Relay.
React Starter Kit-قالب المشروع ، تم تكوينه مسبقًا مع WebPack و React

كيفية المساهمة

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