stay booker hotel booking express api

Stay Booker Hotel Booking Express API

مرحبًا بك في مستودع Stay Booker Hotel Booking Express API. تعمل واجهة برمجة تطبيقات هذه العمود الفقري لـ The Stay Booker Hotel Booking Frontend ، مما يوفر حلاً قويًا للواجهة الخلفية لإدارة حجوزات الفنادق وحسابات المستخدمين والمزيد. تم تصميم هذا المشروع مع express.js ومدمجة مع MySQL من خلال Sequelize ، وتم تصميم هذا المشروع لتقديم منصة سلسة وفعالة لتطبيقات حجز الفنادق.

ابدء

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

• Node.js (V16 أو أوصت لاحقًا)
• MySQL
• غيت
• ساعي البريد (لاختبار نقاط نهاية API)

إعداد البيئة

1. استنساخ المستودع

git clone https://github.com/iZooGooD/stay-booker-hotel-booking-express-api.git
cd stay-booker-hotel-booking-express-api

2. تثبيت التبعيات

npm install

3. قم بإعداد MySQL

تأكد من تثبيت MySQL على Windows/Linux/Mac. قم بإنشاء قواعد بيانات: واحدة للإنتاج وواحدة للاختبار.

 CREATE DATABASE staybooker_prod ;
CREATE DATABASE staybooker_test ;

4. تكوين متغيرات البيئة

انسخ ملف .env.example إلى ملف جديد يسمى .env وقم بتحديثه باستخدام إعدادات قاعدة بيانات MySQL الخاصة بك والتكوينات الأخرى.

 # Development Environment
DEV_DB_HOST=localhost
DEV_DB_USER=yourusername
DEV_DB_PASS=yourpassword
DEV_DB_NAME=staybooker_test

# Production Environment
PROD_DB_HOST=localhost
PROD_DB_USER=yourusername
PROD_DB_PASS=yourpassword
PROD_DB_NAME=staybooker_prod

# JWT Secret
JWT_SECRET=jwtsecretforproject

تشغيل التطبيق

عند بدء التطبيق ، ستقوم Sequelize بإنشاء الجداول اللازمة تلقائيًا في قاعدة البيانات المحددة.

npm run start:dev

اختبار نقاط نهاية API مع ساعي البريد

لضمان وظائف API كما هو متوقع ، نوصي باستخدام ساعي البريد لاختبار نقاط النهاية. استيراد مجموعة Postman المقدمة (إن وجدت) لبدء اختبار وظائف واجهة برمجة التطبيقات ، بما في ذلك مصادقة المستخدم وقوائم الفنادق والحجوزات والمزيد.

تتمة و mysql

يستخدم هذا المشروع Sequelize ، وهي Node.js ORM ، لإدارة قواعد البيانات. يقوم Sequelize بتبسيط تفاعلات MySQL ، مما يتيح معالجة البيانات السهلة والاستعلام من خلال النماذج التي تمثل جداول قاعدة البيانات. تم العثور على التكوين للتتميس في config/config.js ، والطرز موجودة في دليل models .

المساهمة

نرحب بالمساهمات في Stay Booker Hotel Booking Express API! سواء أكان إضافة ميزات جديدة أو إصلاح الأخطاء أو تحسين الوثائق ، يتم تقدير مساعدتك. يرجى قراءة إرشاداتنا المساهمة (المراد إنشائها) لمزيد من المعلومات حول كيفية المساهمة بفعالية.

جودة الكود

جودة الرمز تهم كثيرًا في هذا المشروع. نحن نسعى جاهدين للحفاظ على معايير عالية من جودة الكود وقابلية القراءة. يرجى التأكد من أن مساهماتك تلتزم بهذه المعايير واختبارها جيدًا.

رخصة

تم ترخيص هذا المشروع بموجب ترخيص معهد ماساتشوستس للتكنولوجيا - راجع ملف الترخيص للحصول على التفاصيل.