batnoter api
v1.0.0
هذه هي خدمة API لتطبيق Batnoter المصمم مع Golang.
إنه يعرض نقاط نهاية الراحة للوصول إلى وإدارة ملاحظات التخفيض من مستودع GIT الخاص بالمستخدم. حاليًا يدعم مستودع GitHub فقط لتخزين وإدارة الملاحظات.
1.18 أو أعلىالأوامر أدناه استخدم Docker لبدء حاوية قاعدة البيانات.
make network
make postgres
make createdb config.yaml هو ملف قالب التكوين الذي يحتوي على قيم التكوين الافتراضية.
cp config.yaml .config.yaml يستخدم التطبيق ملف .config.yaml للحصول على قيم التكوين. يرجى تحديث قيم العناوين المائية من ملف التكوين هذا إلى المقاعد الفعلية.
تأكد من تكوين ملف .config.yaml بشكل صحيح وأن حاوية قاعدة البيانات قيد التشغيل. ثم قم بتشغيل الأوامر أدناه لإعداد مخطط DB وبدء خادم الويب.
go run main.go migrateup
go run main.go serve سيؤدي ذلك إلى بدء تشغيل الخادم على المنفذ المحدد في ملف .config.yaml . يمكنك الآن الوصول إلى نقاط نهاية API.
go test -v -cover ./...سيؤدي ذلك إلى تنفيذ جميع الاختبارات ويطبع أيضًا نسبة تغطية الكود.
كل مساهمة تحدث فرقا
اقرأ إرشادات المساهمة قبل المساهمة.
