Skip to content

Netanel1010/NodeJS-REST-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Server Setup Guide

מדריך מלא להתקנה והפעלה של השרת

📋 דרישות מקדימות

לפני שמתחילים, יש לוודא שמותקנים הכלים הבאים:

בדיקת התקנת Node.js

node -v
npm -v

תוצאה צפויה: אם אתה רואה מספרי גרסה (למשל v18.17.0 ו-9.6.7) - הכל תקין! ✅

אם לא רואה מספרים: יש להתקין את Node.js מהאתר הרשמי.


⚙️ הגדרת סביבת העבודה

1. יצירת קובץ .env

בשורש הפרויקט, צור קובץ בשם .env והוסף את השורה הבאה:

PORT=3000

💡 טיפ: אפשר לשנות את המספר 3000 למספר פורט אחר (גדול יותר) לפי הצורך.


🚀 התקנה והפעלה

2. התקנת חבילות (חובה!)

בתוך תיקיית הפרויקט, הרץ את הפקודה הבאה:

npm install

המתן עד שהפקודה תסיים - יווצר תיקיית node_modules עם כל החבילות הנדרשות.


3. הפעלת השרת

לאחר התקנת החבילות, הפעל את השרת באמצעות:

npx nodemon server.js

השרת אמור להיות פעיל וזמין! 🎉


💎 שיפור חווית הפיתוח (אופציונלי)

לניהול נוח יותר של הפרויקט, מומלץ להוסיף סקריפטים מותאמים אישית.

הוספת סקריפט ל-package.json

פתח את הקובץ package.json והוסף את המקטע הבא תחת "scripts":

"scripts": {
  "dev": "nodemon server.js"
}

הרצה באמצעות הסקריפט

כעת תוכל להריץ את השרת בצורה פשוטה יותר:

npm run dev

📚 סיכום

שלב פקודה תיאור
1 node -v && npm -v בדיקת התקנת Node.js
2 npm install התקנת חבילות
3 npx nodemon server.js הפעלת השרת
4 (אופציונלי) npm run dev הפעלה דרך סקריפט מותאם

🔧 פתרון בעיות נפוצות

השרת לא עולה?

  • ודא שקובץ .env קיים ומכיל את PORT=3000
  • ודא שהתקנת את החבילות עם npm install
  • בדוק שאין תהליך אחר שכבר משתמש בפורט 3000

nodemon לא מותקן?

npm install -g nodemon

📞 תמיכה

נתקלת בבעיה? פתח issue או צור קשר עם צוות הפיתוח.


Happy Coding! 💻✨

About

Built during my second year (semesters 1) of Software Engineering practical studies. This full-stack back-end was developed using [ Node.js] and reflects my foundational skills.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors