Skip to content

QUICKSTART.md

Latest commit

 

History

History
111 lines (87 loc) · 2.85 KB

QUICKSTART.md

File metadata and controls

111 lines (87 loc) · 2.85 KB

Quick Start Guide

🚀 Getting Started in 5 Minutes

Step 1: Database Setup

  1. Start XAMPP and launch MySQL
  2. Open phpMyAdmin (http://localhost/phpmyadmin)
  3. Create a new database named student_learning_platform
  4. Import the schema:
    • Go to SQL tab
    • Copy contents from database/schema.sql
    • Click "Go"
  5. Import seed data:
    • Go to SQL tab
    • Copy contents from database/seed_data.sql
    • Click "Go"

Step 2: Backend Configuration

  1. Verify PHP is running (XAMPP Apache must be started)
  2. Check database connection in backend/config/database.php
  3. Verify folders exist:
    • backend/uploads/
    • backend/reports/
    • backend/logs/

Step 3: Frontend Setup

  1. Open terminal in frontend folder
  2. Run: npm install
  3. Run: npm start
  4. Browser should open automatically to http://localhost:3000

Step 4: Login

Use one of the demo accounts:

Student Account:

  • Username: sangwabgy
  • Password: Admin@123!

Teacher Account:

  • Username: Teacher1
  • Password: Admin@123!

Admin Account:

  • Username: admin
  • Password: Admin@123!

✅ Verification Checklist

  • MySQL is running
  • Apache is running
  • Database exists and has data
  • Backend folders are created
  • Frontend npm packages installed
  • Can access http://localhost:3000
  • Can login with demo account

🐛 Troubleshooting

"Cannot connect to database"

  • Check MySQL is running in XAMPP
  • Verify database name in backend/config/database.php
  • Ensure database was created successfully

"CORS error" in browser console

  • Check Apache is running
  • Verify API endpoint URL in frontend/src/context/AuthContext.js
  • Ensure it points to: http://localhost/aiprs/backend/api

"Module not found" in frontend

  • Delete node_modules folder
  • Delete package-lock.json
  • Run npm install again
  • Run npm start

Login doesn't work

  • Check Network tab in browser DevTools
  • Verify API call is reaching http://localhost/aiprs/backend/api/auth.php
  • Check PHP error logs in XAMPP

📚 Next Steps

  1. Explore the student dashboard
  2. Browse available courses
  3. Check recommendations
  4. Try taking a quiz
  5. Submit an assignment
  6. View analytics

🔗 Important URLs

💡 Tips

  1. Keep XAMPP control panel open to monitor services
  2. Check browser console for any errors
  3. Use browser DevTools Network tab to debug API calls
  4. Check PHP error logs in backend/logs/ folder
  5. Test with different user roles to see all features

📧 Need Help?

  • Check README.md for detailed documentation
  • Review error logs in browser and backend
  • Ensure all prerequisites are installed
  • Verify file permissions on uploads/logs folders

Happy learning! 🎓