https://github.com/vanheemstrasystems/message-board
Message Board
https://github.com/vanheemstrasystems/message-board
Last synced: 1 day ago
JSON representation
Message Board
- Host: GitHub
- URL: https://github.com/vanheemstrasystems/message-board
- Owner: vanHeemstraSystems
- License: mit
- Created: 2024-12-05T13:49:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-11T13:41:51.000Z (over 1 year ago)
- Last Synced: 2025-10-16T21:00:37.769Z (9 months ago)
- Language: TypeScript
- Size: 1.2 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.ar.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
لوحة الرسائل
# لوحة الرسائل
| | |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| سي آي/سي دي | [](https://github.com/vanHeemstraSystems/message-board/actions/workflows/ci_server.yml)[](https://github.com/vanHeemstraSystems/message-board/actions/workflows/ci_frontend.yml) |
| طَرد | [](https://pypi.org/project/message-board/)[](https://pypi.org/project/message-board/) |
| ميتا | [](https://github.com/pypa/hatch)[](https://github.com/psf/black)[](https://github.com/ambv/black)[](https://spdx.org/licenses/)[](https://github.com/sponsors/vanHeemstraSystems) |
* * *
> لوحة الرسائل التي ستعرض الرسائل المقدمة.
- [التوثيق](./DOCUMENTATION.md)
- [مسرد](./GLOSSARY.md)
- [الصور](./IMAGES.md)
- [مراجع](./REFERENCES.md)
- [القياس عن بعد](./TELEMETRY.md)
**ملخص تنفيذي**
## يذهب
نوصي باستخدام[Cursor.io](https://www.cursor.com/)بيئة التطوير المتكاملة (IDE) لهذا المشروع.
## الخادم
الحصول على التعليمات البرمجية الخاصة بك وتشغيلها على النظام الخاص بك.
**ملحوظة**: تأكد من الوفاء[متطلبات](./200/README.md).
1. **عملية التثبيت:**
```bash
$ cd server
$ hatch --version # optional, will print the version of our package to the terminal without modifying the source directory (e.g. `0.0.1`).
# Without hatch: $ python src/message_board/app.py
$ hatch env create # optional, if the default env already exists you will be told
$ hatch shell # spawn a shell within an environment
(server) $ pip show message-board-server # optional, shows the project details, here 'message-board-server', from `pyproject.toml`
# Name: message-board-server
# Version: 0.1.0 # it takes this from src/message_board/__about__.py
# ...
(server) $ python -c "import sys;print(sys.executable)" # optional, see where your environment's python is located
(server) $ pip install --upgrade pip # optional, the `run` command allows you to execute commands in an environment as if you had already entered it.
(server) $ exit # optional, type `exit` to leave the environment
```
**ملحوظة**: الطريقة الحديثة هي الاستخدام`pyproject.toml`لتثبيت التبعيات، وليس \`\`\`requirements.txt. ومن ثم لا ينبغي أن يكون هناك ملف require.txt.
=== البدء: قم بتحديث هذا القسم للوحة الرسائل ===
**حزم موقعك باستخدام حزمة الويب:**بمجرد أن يكون لديك موقع ويب جيد بما يكفي لاستخدامه، يجب عليك حزم التطبيق مع حزمة الويب. تم إدراج مجلد الحزمة هذا في`.gitignore`لتجنب ذلك يجب الالتزام بـ git.
يجب أن تكون جميع الإعدادات جاهزة الآن، لذا كل ما عليك فعله:
1)`$ hatch shell`2)`(threagile-monitoring) $ cd src/threagile_monitoring`3)`(threagile-monitoring) $ npm install`4)`(threagile-monitoring) $ npm run build`
سيؤدي هذا إلى إنشاء`app.js`الملف - الذي يحتوي على جميع المكونات - في`/src/threagile_monitoring/static/js/`.
**التطوير باستخدام حزمة الويب:**إذا كنت لا تزال تقوم بتطوير موقع الويب الخاص بك، في**جلسة طرفية منفصلة**، بعد اتباع عملية التثبيت المذكورة أعلاه، قم بما يلي:
1)`$ hatch shell`2)`(threagile-monitoring) $ cd src/threagile_monitoring`3)`(threagile-monitoring) $ npm install`4)`(threagile-monitoring) $ npm run watch`
سيؤدي هذا - في الجلسة الطرفية المنفصلة (أي`background`) - قم بتحميل التغييرات التي تجريها باستمرار على الملفات المناسبة، بينما يمكنك الاستمرار في إجراء هذه التغييرات - في الجلسة الطرفية الأولية (أي:`foreground`). لذلك لا يتوجب عليك بناء مصادرك بعد كل تعديل، بل يتم الاهتمام بها تلقائيًا!
لرؤية التغييرات، ما عليك سوى حفظ متصفحك وإعادة تحميله (عادةً باستخدام F5).
تأكد من تشغيل صفحة الويب الخاصة بك عند الاختبار باستخدام وظائف الواجهة الخلفية، كما يلي:
1)`(threagile-monitoring) $ cd src/threagile_monitoring`2)`(threagile-monitoring) $ python app.py`
**امتحان**
اختبر التطبيق (الواجهة الأمامية) بهذه الطريقة:
1)`$ hatch shell`2)`(threagile-monitoring) $ cd src/threagile_monitoring`3)`(threagile-monitoring) $ npm install`4)`(threagile-monitoring) $ npm test`5)`(threagile-monitoring) $ npm test -- --coverage`
**يجري:**
إذا لم يكن قيد التطوير، قم بتشغيل التطبيق (الواجهة الخلفية والواجهة الأمامية في وقت واحد) بهذه الطريقة:
$ hatch run python src/threagile_monitoring/app.py # starts the app
2. تبعيات البرمجيات
3. أحدث الإصدارات
4. مراجع واجهة برمجة التطبيقات
5. البناء والاختبار:
لبناء الكود الخاص بك، استخدم:
```bash
$ cd threagile-monitoring
$ hatch build
```
لاستخدام الذكاء الاصطناعي لمراجعات طلبات السحب، استخدم:
(الاستخدامات`phpstan.neon`)
لتشغيل التطبيق استخدم:
لينكس:
```bash
$ export SECRET_KEY="secret"
```
ويندوز:
```bash
$ setx SECRET_KEY secret
```
ثم:
```bash
$ cd threagile-monitoring
# Without hatch: $ python src/threagile_monitoring/app.py
$ hatch run python src/threagile_monitoring/app.py
```
ثم انتقل إلى`http://127.0.0.1:5000/`في متصفح الويب الخاص بك.
لتشغيل الاختبارات استخدم:
```bash
$ cd threagile-monitoring
$ pip install pytest # optional
$ pytest tests/
```
# عامل ميناء
**ملحوظة**: للاستخدام الفعال للموارد، نستخدمها**مهزوما**بدلاً من**عامل ميناء**!
أضف هذه السطور إلى ~/.zshrc أو ~/.bashrc:
alias docker=podman
alias docker-compose='podman compose'
ثم أعد تحميل تكوين Shell الخاص بك:
$ source ~/.zshrc # if using zsh
# or
$source ~/.bashrc # if using bash
تثبيت podman-compose عبر النقطة:
$ pip install podman-compose
التحقق من التثبيت:
$ podman compose --version
# تحقق من وجود أي أجهزة Podman
$ podman machine list
# إذا لم يكن هناك جهاز، قم بإنشاء واحد
$ podman machine init
# قم بتشغيل آلة بودمان
$ podman machine start
# قم بتعيين مسار المقبس
$ export DOCKER_HOST=unix://$HOME/.local/share/containers/podman/machine/podman.sock
# تحقق من أن Podman يعمل
$ podman ps
ابدأ تشغيل حاويات Docker الخاصة بك باستخدام:
$ cd containers/app
# For Linux
$ xhost +local:docker
$ docker compose --file docker-compose.dev.yml --project-name message-board-dev up --build -d
# For macOS with XQuartz
# On macOS we need to start XQuartz first. Here's the complete sequence:
# 1.Install XQuartz if you haven't already:
$ brew install --cask xquartz
# 2. Start XQuartz:
$ open -a XQuartz
# 3. You should see an "X" icon in your menu bar at the top of the screen. Click on it to open XQuartz preferences.
# 4. In XQuartz preferences, go to the "Security" tab and make sure "Allow connections from network clients" is checked.
# 5. Wait a few seconds for XQuartz to fully start up
# 6. Set display to local fisrt:
$ export DISPLAY=:0
# 7. Get your IP address
$ export IP=$(ifconfig en0 | grep inet | awk '$1=="inet" {print $2}')
# 8. Allow X11 forwarding from your IP
$ xhost + $IP
# 9. Install podman and podman compose
$ pip install podman podman-compose
# 10. Initialize and start a new Podman machine with the correct mount (our cloned GitHub repository 'message-board' should reside in the '/usr/local/opt/code' directory)
$ podman machine init --now --volume /usr/local/opt/code:/home/user/code
$ podman machine set --rootful
$ podman machine start
$ podman volume create cloudbeaver-config
$ podman run --rm \
-v cloudbeaver-config:/config \
-v $(pwd)/initial-data.conf:/initial-data.conf:ro \
alpine cp /initial-data.conf /config/
# 11. Then in your terminal:
# Remove the existing pod
$ podman pod rm -f pod_message-board-dev
# Remove any existing volumes
$ podman volume rm -f message-board-dev_dbvis-config
$ podman volume rm -f message-board-dev_message-board-data
# Verify everything is clean
$ podman pod ls
$ podman ps -a
$ podman volume ls
# Then start fresh
$ podman-compose --file docker-compose.dev.yml --project-name message-board-dev up -d --build
# or alternatively (since we have a mapping in ~/.zshrc file to map docker to podman):
$ docker compose --file docker-compose.dev.yml --project-name message-board-dev up -d --build
# The key is that XQuartz must be running before you execute the xhost command.
# For Windows with VcXsrv
$ set DISPLAY=host.docker.internal:0
$ docker compose --file docker-compose.dev.yml --project-name message-board-dev up --build -d
سيؤدي ذلك إلى تدوير ثلاث حاويات:
- تطوير خادم لوحة الرسائل (المنفذ 8080:5000)
- تطوير الواجهة الأمامية للوحة الرسائل (المنفذ 80:3000)
- تطوير قاعدة بيانات لوحة الرسائل (المنفذ 5432:5432)
- لوحة الرسائل-db-gui-dev (المنفذ 5444:5444)
جميع الحاويات الأربع تعمل بنجاح. دعونا نتحقق من كل خدمة:
1) الواجهة الأمامية (Vue.js):
- تفضل بزيارة http://localhost:80 في متصفحك
2) الواجهة الخلفية (القارورة):
- تفضل بزيارة http://localhost:8080/api/health في متصفحك
- يجب أن يعود رد التحقق من الصحة
3) قاعدة البيانات (PostgreSQL):
- قيد التشغيل بالفعل وبصحة جيدة (كما هو موضح في الحالة)
- يمكن الوصول إليه على المضيف المحلي: 5432
4) كلاود بيفر (DB GUI):
- قم بزيارة http://localhost:8978
- الإعداد لأول مرة:
- قم بإنشاء بيانات اعتماد المسؤول عند المطالبة بذلك
- اسم المستخدم: cbadmin
- كلمة المرور: S3cr3tPwd
- انقر فوق "اتصال جديد"
- اختر "بوستغريسكل"
- أدخل تفاصيل الاتصال:
- المضيف: قاعدة البيانات
- المنفذ: 5432
- قاعدة البيانات: message_board_db
- اسم المستخدم: db-user-dev
- كلمة المرور: ديسيبل كلمة المرور ديف
يجب أن يتصل DbVisualizer بقاعدة بيانات PostgreSQL الخاصة بك باستخدام بيانات الاعتماد التالية:
الخادم: قاعدة البيانات
المنفذ: 5432
قاعدة البيانات: message_board_db
اسم المستخدم: db-user-dev
كلمة المرور: ديسيبل كلمة المرور ديف
إذا لم يتم تشغيل DbVisualizer تلقائيًا، فيمكنك التحقق من سجلات الحاوية:
$ docker logs message-board-db-gui-dev
# وثائق واجهة برمجة التطبيقات
انتقل إلى`http://127.0.0.1:5000/docs`في متصفح الويب الخاص بك، أو قم بتنزيل openapi.json من`http://127.0.0.1:5000/openapi.json`.
# المقاييس
دع أداة مثل بروميثيوس تتخلص`http://127.0.0.1:9464/metrics`.
**_جديد_**
**جدول المحتويات**
- [تثبيت](#installation)
- [مصدر النسخة](#version-source)
- [البيئات](#environments)
- [يبني](#build)
- [رخصة](#license)
## تثبيت
```console
pip install threagile-monitoring
```
## مصدر النسخة
- ال[Hatch-vcs](https://github.com/ofek/hatch-vcs)يحدد البرنامج المساعد لمصدر الإصدار إصدار المشروع باستخدام علامات Git
## البيئات
- تم تعريفها بدقة في قائمة بذاتها[`hatch.toml`](https://hatch.pypa.io/latest/intro/#configuration)
- ال`test`تستخدم المصفوفة[حاويات الفتحة](https://github.com/ofek/hatch-containers)مكون إضافي لتشغيل كل بيئة داخل حاويات Docker؛ يمكن رؤية الاستخدام في[امتحان](.github/workflows/test.yml)سير عمل جيثب
## يبني
- تستخدم جميع أهداف البناء[Hatch-vcs](https://github.com/ofek/hatch-vcs)بناء البرنامج المساعد هوك لشحن أ`_version.py`ملف بحيث يمكن استخدام الإصدار في وقت التشغيل
- تستخدم العجلات[Hatch-mypyc](https://github.com/ofek/hatch-mypyc)أنشئ ملحقًا ربطًا لتجميع جميع التعليمات البرمجية أولاً[Mypyc](https://github.com/mypyc/mypyc)
- ال[يبني](.github/workflows/build.yml)يوضح سير عمل GitHub كيفية:
- يستخدم[cibuildwheel](https://github.com/pypa/cibuildwheel)لتوزيع العجلات الثنائية لكل منصة
- استخدم[برنامج](https://hatch.pypa.io/latest/plugins/builder/app/)بناء الهدف لبناء توزيعات مستقلة لكل منصة
## رخصة
`threagile-monitoring`يتم توزيعها بموجب شروط[مع](https://spdx.org/licenses/MIT.html)رخصة.
=== END: UPDATE THIS SECTION FOR message board ===
## الواجهة الأمامية
1) قم بإنشاء تطبيق SvelteKit:
$ cd containers/app
$ npx sv create frontend
Choose "SvelteKit demo"
Choose Yes, using Typescript syntax
Choose prettier, eslint, vitest, tailwindcss
Choose typography, forms, container-queries
Choose pnpm
الخطوات التالية:
│ 1: cd frontend │
| 2: pnpm install @sveltejs/adapter-node --save-dev |
| 3: change in svelte.config.js: |
| FROM: import adapter from '@sveltejs/adapter-auto'; |
| TO: import adapter from '@sveltejs/adapter-node'; |
| and: |
| FROM: adapter: adapter() |
| TO: adapter: adapter({ out: 'build' }) |
| 4: Add to package.json: |
| "packageManager": "pnpm@9.14.4", |
│ 5: git init && git add -A && git commit -m "Initial commit" (optional) │
│ 6: pnpm dev --open │
│ │
│ To close the dev server, hit Ctrl-C │
│ │
│ Stuck? Visit us at https://svelte.dev/chat |
| |
| 7: pnpm run build # creates a new build folder with production version |
| 8: pnpm run preview # creates a preview of the production version |
## مشكلات الذاكرة (في نظام Mac):
فيما يلي العديد من الخطوات التي يمكنك اتخاذها لمعالجة مشكلة الذاكرة:
1. **تحقق من الذاكرة المتوفرة**:
- افتح مراقب النشاط من قائمة Apple.
- حدد علامة التبويب "الذاكرة".
- انظر إلى عمود "الاستخدام" لمعرفة مقدار الذاكرة المستخدمة حاليًا.
2. **أغلق التطبيقات غير الضرورية**:
- تأكد من عدم تشغيل أي تطبيقات غير ضرورية قد تستهلك الذاكرة.
3. **مسح ذاكرة التخزين المؤقت**:
- في بعض الأحيان، يمكن أن يساعد مسح ذاكرة التخزين المؤقت في تحرير الذاكرة.
4. **أعد تشغيل جهاز الكمبيوتر الخاص بك**:
- في بعض الأحيان، يمكن أن تؤدي عملية إعادة التشغيل البسيطة إلى حل مشكلات الذاكرة.
5. **التحقق من وجود تحديثات**:
- تأكد من تحديث نظام التشغيل والتطبيقات لديك.
6. **التحقق من وجود تسرب للذاكرة**:
- استخدم أدوات مثل Valgrind أو Instruments للتحقق من تسرب الذاكرة في تطبيقك.
7. مسح موارد Docker:
- قم بتشغيل الأمر التالي لإزالة كافة موارد Docker غير المستخدمة:
docker system prune -a
8. حدود ذاكرة سطح المكتب Docker
يمكنك تقييد استخدام موارد Docker Desktop:
افتح دوكر سطح المكتب
انتقل إلى الإعدادات/التفضيلات
حدد "الموارد"
تقليل حد الذاكرة (على سبيل المثال، إلى 4-6 جيجابايت حسب نظامك)
9. تحسين XQuartz
قم بإنهاء XQuartz وإعادة تشغيله
فكر في استخدام XQuartz عند الحاجة فقط بدلاً من إبقائه قيد التشغيل
10. الحلول على مستوى النظام:
مسح ذاكرة التخزين المؤقت للنظام:
sudo purge
التحقق من استخدام المبادلة:
sysctl vm.swapusage
11. حلول طويلة الأمد:
- ترقية الأجهزة الخاصة بك:
- فكر في استخدام جهاز أكثر قوة مزودًا بذاكرة وصول عشوائي أكبر.
- تحسين التطبيق الخاص بك:
- استخدم أدوات تحديد مواصفات الذاكرة لتحديد العمليات كثيفة الاستهلاك للذاكرة وتحسينها.
- مراقبة وإدارة الموارد:
- استخدم أدوات مثل`htop`أو`iostat`لمراقبة موارد النظام وإدارتها بفعالية.
- قم بإعداد البرامج النصية للتنظيف التلقائي لحاويات وصور Docker.
إذا استمرت المشكلة، فقد ترغب في القيام بما يلي:
1. Monitor which application is consuming the most memory
2. Consider alternatives to running all these applications simultaneously
3. Use lightweight alternatives where possible (e.g., Podman instead of Docker Desktop)
## 100- مقدمة
يرى[README.md](./100/README.md)
## 200 - المتطلبات
يرى[README.md](./200/README.md)
## 300 – بناء تطبيقنا
يرى[README.md](./300/README.md)
## 400 - الخاتمة
يرى[README.md](./400/README.md)