الصفحة الرئيسية>موارد بناء الموقع>بيانات الموقع
تنزيل

تطبيق Starter لبناء واجهات برمجة التطبيقات مع Express.js

يأتي مع:

  • ميزات/الوحدات النمطية ES6
  • ES7 Async/في انتظار
  • رف الكتب orm و knex.
  • PostgreSQL (افتراضي) بدعم من MySQL و SQLite
  • وثائق API باستخدام Swagger-ui-dist و swagger-jsdoc
  • دعم Docker للتنمية والإنتاج
  • eslint ل code linting
  • طلب التحقق من الصحة باستخدام JOI
  • تنسيق الكود باستخدام أجمل
  • إدارة التكوين باستخدام dotenv
  • تسجيل باستخدام وينستون
  • خطأ في الإبلاغ باستخدام Sentry
  • اختبارات باستخدام موكا ، خارقة وشاي
  • مقابل الدعم المدمج في الكود

المتطلبات الأساسية

  • node.js
  • غزل
  • NPM
  • postgresql / mysql / sqlite

يثبت

استنساخ المستودع ، وتثبيت التبعيات وابدأ على الفور. 

 $ git clone --depth=1 [email protected]:mesaugat/express-api-es6-starter.git <application-name>
$ cd <application-name>
$ rm -rf .git
$ yarn   # or npm install

قم بعمل نسخة من .env.example كـ .env وتحديث تفاصيل التطبيق الخاصة بك وبيانات اعتماد قاعدة البيانات. الآن ، قم بتشغيل الترحيل وبذور قاعدة البيانات. 

 $ yarn migrate
$ yarn seed

أخيرًا ، ابدأ التطبيق. 

 $ yarn start:dev (For development)
$ NODE_ENV=production yarn start (For production)

انتقل إلى http: // localhost: 8848/api-docs/للتحقق من التثبيت.

خلق هجرات وبذور جديدة

هذه هي الأوامر لإنشاء ترحيل جديد وملف البذور المقابل. 

 $ yarn make:migration <name>
$ yarn make:seeder <name>

مثال، 

 $ yarn make:migration create_tags_table
$ yarn make:seeder 02_insert_tags

باستخدام Docker

باستخدام Docker-Cormse

استخدم Docker-Cormse لإحضار مكدس بسرعة مع حاوية قاعدة بيانات Postgres التي تم تكوينها مسبقًا. البيانات سريعة الزوال وستختفي الحاويات عند إزالة المكدس.

تكوين محدد لـ Docker في .env.docker

  • 0.0.0.0 كـ $APP_HOST لفضح التطبيق على واجهة شبكة Docker
  • إعدادات Postgres التي تم تكوينها مسبقًا - يمكن تحديثها للإشارة إلى مضيف آخر بعد

إحضار مكدس ، 

 $ docker-compose up

انتقل إلى http: // localhost: 8848/API-DOCS/للتحقق من التطبيق يعمل من Docker.

إسقاط المكدس ، 

 $ docker-compose down

يبني Docker متعددة المراحل

هناك العديد من أهداف البناء المتاحة لمراحل مختلفة. يمكن استخدام هذه الصور لنشر أو تشغيل الوظائف في البنية التحتية السحابية القائمة على الحاويات مثل Kubernetes و AWS ECS و Fargate و GCP Cloud Run وما إلى ذلك.

  1. بناء صورة إنتاج. 

    $ docker build --target=prod -t express-api-es6-starter:prod .

  2. بناء صورة للتنمية. 

    $ docker build --target=dev -t express-api-es6-starter:dev .

  3. بناء صورة تدير الترحيل و/أو التراجع. 

     # Docker image that runs migration and seeds.
 $ docker build --target=migrate -t express-api-es6-starter:migrate .

 # Docker image that rollbacks migrations.
 $ docker build --target=migrate-rollback -t express-api-es6-starter:migrate-rollback .

بمجرد إنشاء الصور - كل ما عليك فعله هو تشغيلها لتوفير ملف .env . مثله: 

$ docker run -v " /path/to/your/.env:/app/.env " mesaugat/express-api-es6-starter:migrate

باستخدام MySQL بدلاً من postgresql

قم بتثبيت برنامج تشغيل MySQL أولاً. 

 $ yarn add mysql

قم بتحديث هذه السطور في ملف .env الخاص بك. 

 - DB_CLIENT='pg'
+ DB_CLIENT='mysql'

- DB_PORT='5432'
+ DB_PORT='3306'

يمكنك إزالة برنامج تشغيل PG إذا كنت ترغب في ذلك. 

 $ yarn remove pg

هذا كل شيء ، أنت مستعد للفة.

الاختبارات

لتشغيل الاختبارات التي تحتاجها لإنشاء قاعدة بيانات اختبار منفصلة. لا تنس تحديث ملف .env لتضمين اتصالات قاعدة بيانات الاختبار. 

 $ NODE_ENV=test yarn migrate
$ yarn test

تشغيل الاختبارات مع التغطية. 

 $ yarn test:coverage

لماذا 8848؟

لأن أعلى نقطة في العالم هي 8848 متر.

المساهمة

للمساهمة وطلبات الميزات ، يرجى إنشاء مشكلة أولاً.

رخصة

Express-api-es6-starter تحت رخصة معهد ماساتشوستس للتكنولوجيا.

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل