briefkasten

؟ Briefkasten

briefkasten (en: صندوق البريد) - أنا haus- oder wohnungseingang angebrachter behälter für die dem empfänger zugestellten [post] sendungen

تطبيق إشارة مرجعية مستضافة ذاتيا. يعمل مع أي قاعدة بيانات متوافقة مع Prisma (MySQL ، Postgres ، SQLite ، إلخ)

تحذير

Briefkasten V2 متاح حاليًا في الإصدار التجريبي على https://dev.briefkastenhq.com

بعد فترة بيتا ، سيتم إسقاط قاعدة البيانات ، حتى نتمكن من ترحيل جميع البيانات الحالية من briefkastenhq.com الحالي (V1) إلى الإصدار الجديد. أنا أعمل على مستندات جديدة بالفعل ، لكن مستندات V1 لا تزال متاحة بالطبع. إذا وجدت أي أخطاء ، أو تريد المساعدة بطريقة أخرى ، فيمكنك المساهمة في ndom91/sveltekasten أو ndom91/briefkasten-docs .

مثال مجاني: briefkastenhq.com [مستندات]

؟ لقطات الشاشة

؟ سمات

• حفظ عن طريق امتداد المتصفح
• العنوان التلقائي والوصف استخراج
• عناوين URL للسحب والإفلات على الصفحة للحفظ
• اختصارات لوحة المفاتيح
• تنظيم حسب الفئات والعلامات
• مرجعية استيراد وتصدير من تنسيق HTML القياسي
• مرجعية صورة جلب وظيفة الخلفية
• وجهات نظر متعددة
• البحث الكامل
• استراحة API
• OAUTH + البريد الإلكتروني تسجيل الدخول إلى الرابط السحري

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

لاستضافة هذا التطبيق ذاتيًا ، ستحتاج إلى الترشيح التالية:

1. منصة الخادم / الاستضافة لتطبيق Next.js (أي Vercel / NetLify)
2. لتسجيل الدخول إلى Oauth ، حساب مطور في أي من مقدمي الخدمات المدعوين من Nextauth.js
3. قاعدة البيانات التي تعمل مع Prisma (أي mysql ، postgres ، sqlite ، إلخ)
4. مساحة استضافة الصور (أي supabase / imagekit / cloudinary) ( اختياري )

هذه كلها مستقيمة نسبيا إلى الأمام ، بخلاف Hoster الصورة. تم اختيار هذا لتجنب وضع الصور في قاعدة البيانات. يستخدم تطبيق المثال في briefkastenhq.com تخزين supabase ، ولكن أي مزود مماثل آخر مثل Cloudinary أو S3 S3 سيقوم أيضًا بالمهمة. لقد اخترت supabase ، لأن لديهم سهلة الاستخدام SDK ، وهي طبقة مجانية لائقة ، وكنت أستخدم بالفعل خدمة Postgres الخاصة بهم.

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

ابدء

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

$ git clone [email protected]:ndom91/briefkasten.git && cd briefkasten

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

$ pnpm install

3. انسخ ملف .env.example إلى .env ، وفتحه مع محرر النصوص المفضل لديك لملء متغيرات البيئة الخاصة بك.

$ cp .env.example .env
$ vim .env

في ملف متغيرات البيئة هذا ، تأكد على الأقل من ملء DATABASE_URL و NEXTAUTH_URL و NEXTAUTH_SECRET . تعتمد بقية متغيرات البيئة على الخدمات / الميزات التي تريد استخدامها. على سبيل المثال ، Google/Github لتسجيل الدخول إلى OAUTH و/أو supabase لتخزين الكائن.

4. ابدأ الخادم!

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

؟ عامل ميناء

يمكنك أيضا استضافة ذاتيا براونكاستن مع Docker. للقيام بذلك ، يجب عليك:

1. تثبيت docker و docker-compose .
2. استنساخ المستودع ونسخ .env.example إلى ملف .env .
   1. هنا تحتاج أيضًا إلى ملء متغيرات البيئة DATABASE_URL و NEXTAUTH_* على الأقل.
   2. يجب أن يكون DATABASE_URL لحاوية postgres DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
3. قم بتشغيل docker-compose up -d في جذر المستودع. سيبدأ هذا التطبيق وكذلك قاعدة البيانات لك.
4. بعد البداية الأولية ، لا يزال يتعين عليك بذرة قاعدة البيانات يدويًا. يتم القيام بذلك بسهولة من خلال حاوية التطبيق ( bk-app ).
   1. Run docker exec -it bk-app /bin/bash للدخول إلى جلسة طرفية داخل الحاوية.
   2. ثم قم بتشغيل pnpm db:push داخل الحاوية. سيؤدي ذلك إلى دفع مخطط قاعدة البيانات من PRISMA إلى قاعدة البيانات التي تم تكوينها.
5. الآن يجب أن يكون التطبيق وقاعدة البيانات الخاصة بك قيد التشغيل في http://localhost:3000

يمكن العثور على مزيد من التفاصيل في قسم Docker في المستندات.

؟ متعلق ب

؟ احفظ من قائمة مشاركة Android

من خلال اختصارات HTTP للتطبيق المفتوح المصدر ، يمكنك إنشاء عنصر "Share Menu" الذي ينفذ طلبًا POST بإدخال ديناميكي ، أي عنوان URL لصفحة الويب وعنوانه. هذا يجعل من السهل للغاية مشاركة العناصر من هاتفك إلى briefkasten! مزيد من المعلومات في المستندات.

؟ تمديد المتصفح

يوجد ملحق مصاحب للمتصفح في الأعمال التي يمكنك استخدامها لإضافة مواقع الويب إلى قبو الخاص بك أثناء تصفح الويب. يمكن العثور عليها في ndom91/briefkasten-extension وفي متجر تمديد الكروم. مزيد من التفاصيل في هذا المستودع.

؟ ‍؟ وظيفة لقطة الشاشة

هناك أيضًا وظيفة خلفية لملء الإشارات المرجعية التي لا تحتوي على صورة صالحة. يمكن العثور عليها في مستودع ndom91/briefkasten-scrape . تعمل هذه المهمة كل ساعتين في إجراء GitHub وتعالج 10 إشارات مرجعية في وقت واحد.

؟ المساهمة

هذا المشروع مفتوح لأي وجميع المساهمات! يرجى التمسك بالإعدادات ESLINT / أجمل وسأكون سعيدًا بإلقاء نظرة على مشكلتك / العلاقات العامة؟

رخصة

معهد ماساتشوستس للتكنولوجيا