wallstreetlocal
1.0.0
موقع ويب يسمح لك بعرض استثمارات أكبر مستثمرين في أمريكا.
تحتفظ لجنة الأوراق المالية والبورصة (SEC) بسجل كل شركة في الولايات المتحدة. الشركات التي تتجاوز مقتنياتها 100 مليون دولار ، على الرغم من ذلك ، مطلوب لتقديم نوع خاص من النماذج: نموذج 13F. يكشف هذا النموذج ، الذي تم تقديمه كل ثلاثة أشهر ، عن مقتنيات الإفلاس ، مما يوفر الشفافية في أنشطتهم الاستثمارية والسماح للمشاركين العامين وغيرهم من المشاركين في السوق بمراقبتها.
ومع ذلك ، فإن المشكلة هي أن هذه المقتنيات غالبًا ما تكون مرهقة للوصول ، وغالبًا ما يتم إخفاء التحليل القيمة خلف جدار paywall. من خلال WallStreetlocal ، يصبح مرشحو 13F في SEC أكثر سهولة وفتحًا.
يحمل هذا المستودع الواجهة الخلفية والواجهة الواجهة لـ Wallstreetlocal.
لزيارة Wallstreetlocal ، يمكنك الذهاب إلى wallstreetlocal.com .
يمكنك أيضًا رؤية الموارد المهمة المستخدمة لإنشاء الموقع في صفحة الموارد ، أو عرض وثائق OpenAPI في صفحة API.
لمزيد من المعلومات ، راجع الوثائق الخاصة بتطوير WallStreetlocal أدناه.
يتم استضافة نسخة إنتاج من الموقع على wallstreetlocal.com ، ولكن من الممكن أيضًا الاستضافة الذاتية.
انتقل إلى مجلد الواجهة الأمامية.
cd frontendتثبيت التبعيات.
npm installنشر.
npm run devأو لبناء الإنتاج ، قم بتشغيل
npm run build
npm run start بمجرد اكتمال الخطوات المذكورة أعلاه ، يجب استضافة الواجهة الأمامية في localhost:3000 ، مع تكوين الواجهة الخلفية تلقائيًا إلى content.wallstreetlocal.com .
إن استضافة الواجهة الأمامية وحدها هي الطريقة الموصى بها للمضيف الذاتي ، ولكن إذا كنت ترغب في استضافة الواجهة الخلفية أيضًا ، انظر أدناه.
لتشغيل كل من عمليات التطوير والإنتاج ، ستحتاج إلى متغيرات البيئة لواجهة برمجة تطبيقات الطرف الثالث. معظم متغيرات البيئة في ملفات المثال المقدمة التي يمكنك الاحتفاظ بها كما هي ، ولكن بالنسبة لمفاتيح API ، ستحتاج إلى زيارة الخدمات التالية.
تتيح هذه الخدمات الثلاث المختلفة للبيانات الأكثر حداثة ودقيقة ، مع تجنب الحد من المعدل أيضًا.
على الرغم من أنه يوصى بإيقاف تشغيل القياس عن بعد للاستضافة الذاتية ، إلا أنه يمكنك تمكين القياس عن بعد من خلال متغير بيئة TELEMETRY .
للقياس عن بعد/التتبع/السجلات ، يستخدم Wallstreetlocal Sentry. يمكنك الاشتراك هنا ، أو استضافة الذات أيضًا.
تم تصميم بناء التطوير بشكل أساسي للاختبار ، لذلك فهو مثالي للاستضافة الذاتية.
لتشغيل التطبيق الكامل ، تحتاج إلى الخدمات المجهرية التي تعمل عبر Docker ، والتطبيق الرئيسي الذي يعمل بشكل منفصل.
يمكنك العثور على ملف التنمية هنا. ستحتاج أيضًا إلى ملف .env يمكن العثور عليه هنا.
بمجرد أن تكون جميع ملفات التكوين جاهزة ، لبدء التطبيق ، قم بتشغيل ما يلي.
انتقل إلى الدليل الخلفي.
cd backendقم بتشغيل الخدمات المجهرية عن طريق استدعاء ملف التنمية.
docker compose -f docker-compose.dev.yaml up -dملاحظة: يجب عليك إيقاف هذه الخدمات المجهرية بعد الانتهاء من استخدامها (وإلا فإنها ستضيع الموارد إلى أجل غير مسمى). لوقفهم ، قم بتشغيل ما يلي.
docker compose -f docker-compose.dev.yaml down # Run after you've finished
تثبيت التبعيات مع الأشعة فوق البنفسجية.
Pipx تثبيت UV # المزيد من الخيارات في https://docs.astral.sh/uv/getting-started/installation/ UV Sync
4. Create and edit the `.env` file using `.env.example`.
5. Run the main application.
```bash
uv run python main.py
تم إنشاء بناء الإنتاج للنشر على نطاق واسع ، لذلك سيكون تشغيله أكثر تعقيدًا.
يمكنك العثور على ملف compose هنا. لا يوجد ملف .env ، حيث يتم تضمين جميع متغيرات البيئة في ملف التأليف.
ما لم تقم بتشغيل بناء الإنتاج لكثير من الناس ، يجب عليك تغيير الإعدادات التالية.
localhostبمجرد أن تكون جميع ملفات التكوين جاهزة ، لبدء التطبيق ، قم بتشغيل ما يلي.
انتقل إلى الدليل الخلفي.
cd backendقم بتشغيل التطبيق بأكمله بأمر واحد.
docker compose -f docker-compose.prod.yaml upإذا كنت تشعر أنه يمكنك المساهمة في هذا المشروع ، أو وجدت خطأ أو إنشاء مشكلة أو طلب سحب.
يتم الحفاظ على هذا المشروع فقط ، لذا فهو عرضة للأخطاء والمضادات ، يرجى الاتصال بهم من حيث تراها. جميع المساهمات موضع تقدير كبير!
رخصة معهد ماساتشوستس للتكنولوجيا
مدونة لقواعد السلوك
