express boilerplate

node.js ، express.js boilerplate مع تكملة orm

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

المتطلبات المسبقة

• تثبيت node.js الإصدار 18.16.1
• تثبيت MySQL 8
• إنشاء قاعدة بيانات سميت في MySQL

ابدء

• إنشاء مستودع من القالب

• قم بإنشاء ملف .env على جذر المشروع وملبئه بالقيم ، للتحقق من المرجع.

 cd <project_name>
 cp .env.example .env

• تثبيت التبعيات

 npm install

• تشغيل الهجرات

 npx sequelize db:migrate

• تملأ قاعدة البيانات مع البذور

 npx sequelize db:seed:all

• ابدأ المشروع في التنمية ENV

 npm run dev

• ابدأ المشروع في الإنتاج ENV

 npm start

انتقل إلى http://localhost:4040

ES Lint و أجمل

• تحقق مما إذا كان التنسيق يتطابق مع قواعد أجمل باستخدام:

 npm run format

• فرض التنسيق باستخدام هذا الأمر:

 npm run format:fix

• الوبر الكود الخاص بك مع:

 npm run lint

• إجبار الابتكار باستخدام هذا الأمر:

 npm run lint:fix

ميزة الفروع

دمج الفروع لتنفيذ الميزات المدرجة أدناه

سمات

• مستندات Swagger: feat/swagger-docs
• Twilio SMS: feat/twilio-SMS
• SendGrid Emai: feat/sendgrid-mail
• دلو AWS S3: feat/AWS-S3-bucket
• مآخذ: feat/sockets
• عقدة كرون: feat/node-cron

CI (يستمر التكامل)

• اختبارات تكامل Jest (إجراءات GIT): ci/jest-test

ملحوظة

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

 git remote add template <template_repository_url>
git fetch template <template_repo_branch_name>
git checkout <template_repo_branch_name>
git push origin <template_repo_branch_name>

من خلال تشغيل الأوامر المذكورة أعلاه ، سيتم دفع فرع Specfic إلى الريبو الخاص بك.