התקנה ויצירת פרויקט
יוצרים שלד של פרויקט Xuda CLI בפקודה אחת, ואז לומדים למה משמש כל קובץ שנוצר.
לפני שמתחילים
דרך ה-CLI צריכה Node.js בגרסה 18.17.0 ומעלה, שהיא רצפת המנוע ש-xuda-cli מצהיר עליה. שום דבר נוסף: xuda-cli עצמו תלוי בשלוש חבילות (express, socket.io, chokidar), ולמערכת שיוצרת שלד לפרויקט חדש אין תלויות משלה. פיתוח מקומי אף פעם לא קורא לשיטה שמוגבלת בתוכנית, ולכן בניית אפליקציה בדרך הזו לא עולה כסף.
יוצרים שלד לאפליקציה חדשה
רואים מה create-xuda-cli כתב
מערכת יצירת השלד כותבת package.json שכבר מצהיר על @xuda.io/xuda-framework-plugin-tailwind ועל @xuda.io/xuda-dbs-plugin-xuda כתלויות ועל xuda-cli כתלות פיתוח, קובץ xuda.config.js, App.xu, index.html, תיקיית components/, ו-node_modules/.project_data/globals.json ראשון. היא גם מניחה מדריך README.md שנוצר בשתים עשרה תיקיות: אחת עשרה תיקיות המקור המוגדרות לפי סוג ועוד אחת עבור data/ עצמה, וכל אחד מהם ניתן להסרה אחר כך.
פותחים את האפליקציה
npm run dev מדפיס את הכתובת שהוא מאזין בה, http://localhost:3000 כברירת מחדל. index.html מוגש כמעטפת ו-App.xu נטען לתוך #app אוטומטית, כי ההגדרה שנוצרה קובעת entry: 'index.html' ושום רכיב אחר לא תובע את האלמנט הזה. App.xu תמיד מתקמפל למזהה התוכנית app.
עורכים ושומרים
עורכים את App.xu ושומרים. המעקב מקמפל מחדש את הפרויקט, מייצר מחדש את מסמכי סביבת הריצה, ודוחף רענון דרך ערוץ socket.io, כך שהדפדפן מתרענן בעצמו.
מנקים את מדריכי התיקיות כשכבר לא צריך אותם
זה מוחק רק את קובצי ה-README שמערכת יצירת השלד יצרה (הם מזוהים בסמן פנימי). כל README שכתבתם בעצמכם נשאר, והפקודה מדווחת בנפרד על ספירות של שהוסרו, שדולגו ושחסרים.
המודל המנטלי: שלוש שכבות
אם xuda.config.js קובע entry: 'index.html', מעטפת ה-HTML מוגשת קודם ו-App.xu נטען לתוך #app אלא אם משהו אחר כבר תבע את האלמנט הזה. אם entry מושמט, xuda-cli מוגדר כברירת מחדל למזהה התוכנית app במקום לקובץ HTML.
החלוקה המומלצת: להשאיר את index.html כמעטפת הדף, להשאיר את App.xu כמסך הראשי, ולהוסיף מסכי תכונות תחת components/.
מבנה הפרויקט
ראו שפת .xu לאיזה תוכן שייך בכל תיקייה ואיך התיקייה שבה קובץ נמצא קובעת את סוג היחידה שלו.
xuda.config.js
הגדרת build_id הופכת גם את api_key לחובה, והיא מכוונת לנתיב בנייה מרוחק שעדיין אין מאחוריו מימוש, ולכן הפרויקט ייכשל בטעינה במקום להיבנות מרחוק.
כל השאר על פקודות, מצבי SSR וסנכרון ענן נמצא במדריך ה-CLI.
מסמכי סביבת ריצה שנוצרים
xuda-cli תמיד מקמפל מסמכי סביבת ריצה לתוך node_modules/.project_data/, קובץ globals.json אחד ועוד קובץ אחד לכל תוכנית. קבצים ישנים שם נמחקים בכל קומפילציה. מתייחסים אליה כאל פלט בנייה: קובצי ה-.xu וה-.json5 שאתם כותבים הם מקור האמת.
ייתכן שתראו תיקיית project_data/ או תיקיית .project_data/ בשורש בחומרים ישנים יותר. אלה נתיבים ישנים לייבוא בלבד שנשמרו להעברה, אף פעם לא מקום לכתוב בו.