منصوبے کے بارے میں
## پروجیکٹ کا تعارف
ZSB Study Assistant جونیئر کالج سے یونیورسٹی ٹرانسفر (Zhuan Sheng Ben) کے امیدواروں کے لیے ایک اسٹڈی مینجمنٹ ایپلی کیشن ہے، جو ویب ورژن (PWA) اور Windows/macOS ڈیسک ٹاپ ورژن فراہم کرتی ہے۔ Cloudflare Workers + D1 ڈیٹا بیس + R2 اسٹوریج کے ذریعے کلاؤڈ اکاؤنٹ اور ڈیٹا سنکرونائزیشن کی سہولت فراہم کی گئی ہے، جس سے ویب اور ڈیسک ٹاپ پر یکساں ریکارڈ برقرار رہتا ہے۔
بنیادی مقصد: 「ریکارڈ → توجہ → ترغیب → جائزہ」 کو ایک مکمل تعلیمی لوپ میں جوڑنا۔
### اس پروجیکٹ کا انتخاب کیوں کریں؟
- **مکمل تعلیمی لوپ**: روزانہ چیک ان، پومودورو فوکس، سوالات کی مشق، اور رات کا جائزہ، سب ایک ہی ٹول میں۔
- **کلاؤڈ سنکرونائزیشن**: Cloudflare D1 کے ذریعے ڈیٹا ویب اور ڈیسک ٹاپ پر سنک رہتا ہے؛ PWA آف لائن موڈ کو بھی سپورٹ کرتا ہے۔
- **گیمفیکیشن**: کانسی سے لے کر کنگ (King) تک کے رینک، بیجز اور مسلسل سیکھنے کے دن آپ کی ہمت بڑھاتے ہیں۔
- **ریاضی اور انگریزی کی خصوصی تیاری**: باب وار درخت، Markdown+LaTeX فارمولا نوٹس، اور انگریزی کے مختلف حصوں کا ریکارڈ۔
- **ٹاسک کے ساتھ پومودورو**: ٹائمر شروع کرنے سے پہلے ٹاسک لکھیں اور اپنی کارکردگی کا ریکارڈ رکھیں۔
- **کمیونٹی اور اسٹڈی پارٹنر**: فورمز، نجی پیغامات اور ٹیم چیلنجز کے ذریعے دوسروں کے ساتھ مل کر پڑھیں۔
- **ڈیٹا ویژولائزیشن**: ECharts کے ذریعے پڑھائی کے وقت اور درستگی کے رجحانات کا تجزیہ۔
- **ڈیسک ٹاپ + PWA**: Windows/macOS کے لیے نیٹو کلائنٹ اور ویب کے لیے انسٹال ایبل PWA۔
### خصوصیات
| زمرہ | فنکشن |
| :--- | :--- |
| تعلیمی ریکارڈ | مضامین کے ابواب، مطالعہ کا وقت، غلط سوالات کی کتاب، موک ٹیسٹ، روزانہ کے کام |
| نوٹس اور مواد | Markdown+KaTeX نوٹس، لائبریری، PDF ریڈنگ |
| انگریزی اسپیشل | الفاظ کا چیک ان، ریڈنگ، لسننگ، رائٹنگ ٹیمپلیٹس |
| پومودورو فوکس | کاؤنٹ ڈاؤن، ٹاسک کی تفصیل، فوکس وال پیپر |
| عادات اور جائزہ | عادات کی ٹریکنگ، روزانہ کا خلاصہ (جذبات + عکاسی + منصوبہ)، شیئرنگ کارڈز |
| اچیومنٹ | پوائنٹس، چھ رینک لیولز، بیج وال، مسلسل مطالعہ کے دن |
| کمیونٹی | پوسٹس، کمنٹس، لائکس، ٹاپک سرکلز، نوٹیفیکیشن سینٹر |
| تعاون | ٹیم چیلنجز، اسٹڈی پارٹنر، مشترکہ تیاری کے منصوبے |
| اکاؤنٹ اور سیکیورٹی | رجسٹریشن/لاگ ان (bcrypt+JWT)، Cloudflare Turnstile، حساس الفاظ کا فلٹر |
| پرسنلائزیشن | امتحان کی الٹی گنتی، ڈارک موڈ، اوتار کراپنگ، وزیٹر موڈ |
### ٹیکنالوجی آرکیٹیکچر
| لیئر | ٹیکنالوجی |
| :--- | :--- |
| فرنٹ اینڈ | Vue 3, TypeScript, Vite 5, Vue Router 4, Pinia 2, Tailwind CSS 3 |
| ویژولائزیشن | ECharts 5, KaTeX 0.16, markdown-it, pdfjs-dist |
| ڈیسک ٹاپ | Electron 43, electron-builder, electron-updater |
| PWA | vite-plugin-pwa |
| بیک اینڈ | Cloudflare Workers (TypeScript), bcryptjs, jose (JWT) |
| ڈیٹا | Cloudflare D1, R2 |
| انجینئرنگ | ESLint, GitHub Actions |
### فوری آغاز
**ضروریات**: Node.js 18 یا اس سے اعلی ورژن
```bash
git clone https://github.com/Han050912/zsb-study-tracker.git
cd zsb-study-tracker
npm install
npm run dev
```
**بیک اینڈ ورکر شروع کریں (مقامی ترقی کے لیے ضروری)**:
```bash
cd worker
npm install
npm run init:local
npx wrangler dev
```
**ڈیسک ٹاپ کلائنٹ**:
```bash
npm run electron:dev
```
**پیکیجنگ**:
```bash
npm run dist:win # Windows
npm run dist:mac # Mac
```
### تعیناتی (Deployment)
اس پروجیکٹ میں دو GitHub Actions پائپ لائنز ہیں جو فرنٹ اینڈ کو GitHub Pages اور بیک اینڈ کو Cloudflare Workers پر خودکار طور پر تعینات کرتی ہیں۔
### تعاون کی گائیڈ
تعاون کا خیرمقدم ہے! طریقہ کار: Fork → نئی برانچ (feat/xxx) → کوڈنگ → PR جمع کرائیں۔ TypeScript اور Tailwind CSS کا استعمال کریں اور Conventional Commits کی پیروی کریں۔
### لائسنس
یہ پروجیکٹ MIT لائسنس کے تحت اوپن سورس ہے۔
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.