|
Download README.md from simhaa-hat/ai-learning-dashboard-api: direct link, hf CLI and curl.
- Browser
- Download file 5.18 kB
-
https://huggingface.co/spaces/simhaa-hat/ai-learning-dashboard-api/resolve/main/README.md
- Command line
-
hf download hf://spaces/simhaa-hat/ai-learning-dashboard-api/README.md
-
curl -L -o README.md https://huggingface.co/spaces/simhaa-hat/ai-learning-dashboard-api/resolve/main/README.md
5.18 kB
metadata
title: AI Learning Dashboard API
emoji: π
colorFrom: green
colorTo: blue
sdk: docker
app_port: 7860
pinned: false
AI Learning Dashboard - Backend API
A comprehensive RESTful API built with Express.js, TypeScript, and MongoDB for the AI Learning Dashboard.
π Quick Start
Prerequisites
- Node.js (v18 or higher)
- MongoDB (running on localhost:27017)
Installation
- Navigate to the server directory:
cd server
- Install dependencies:
npm install
- Create a
.envfile (copy from.env.example):
# On Windows PowerShell
Copy-Item .env.example .env
# On Linux/Mac
cp .env.example .env
Update the
.envfile with your configurationStart the development server:
npm run dev
The API will be available at http://localhost:5000
π API Documentation
Base URL
http://localhost:5000/api
Authentication
All protected routes require a JWT token in the Authorization header:
Authorization: Bearer <token>
Endpoints
π Authentication
POST /auth/register- Register new userPOST /auth/login- Login userGET /auth/me- Get current user (protected)
π€ User Management
PUT /user/profile- Update user profile (protected)PUT /user/settings- Update user settings (protected)
π Progress & Analytics
GET /progress- Get user progress (protected)POST /progress/quiz- Submit quiz score (protected)POST /progress/study-time- Log study time (protected)GET /analytics/quiz-scores- Get quiz scores trend (protected)GET /analytics/study-time- Get study time data (protected)GET /analytics/improvement- Get improvement metrics (protected)GET /analytics/summary- Get full analytics summary (protected)
π€οΈ Learning Path
GET /learning-path- Get user's learning path (protected)PUT /learning-path/step/:stepId- Update step progress (protected)POST /learning-path/generate- Generate new learning path (protected)
π Resources
GET /resources- Get all resources (public)GET /resources/:id- Get single resource (public)GET /resources/user/recommended- Get AI-recommended resources (protected)POST /resources- Create new resource (protected)
π¬ AI Assistant
POST /assistant/chat- Send message to AI (protected)GET /assistant/history- Get chat history (protected)DELETE /assistant/history- Clear chat history (protected)GET /assistant/suggestions- Get suggested topics (protected)
π― Skill Gaps
GET /skill-gaps- Get user's skill gaps (protected)POST /skill-gaps/assessment- Submit skill assessment (protected)GET /skill-gaps/recommendations- Get recommendations (protected)
ποΈ Project Structure
server/
βββ src/
β βββ config/ # Configuration files
β βββ controllers/ # Request handlers
β βββ middleware/ # Custom middleware
β βββ models/ # MongoDB models
β βββ routes/ # API routes
β βββ types/ # TypeScript types
β βββ server.ts # Entry point
βββ package.json
βββ tsconfig.json
π§ Available Scripts
npm run dev- Start development server with hot reloadnpm run build- Build for productionnpm start- Start production server
ποΈ Database Models
- User - User authentication and preferences
- Progress - Learning progress tracking
- LearningPath - Personalized learning paths
- Resource - Learning materials
- ChatMessage - AI assistant conversation history
- SkillGap - Skill assessments and gaps
π Environment Variables
PORT=5000
NODE_ENV=development
MONGODB_URI=mongodb://localhost:27017/ai-learning-dashboard
JWT_SECRET=your-secret-key
JWT_EXPIRE=7d
CORS_ORIGIN=http://localhost:3000
π Example Usage
Register a new user
POST /api/auth/register
{
"name": "John Doe",
"email": "john@example.com",
"password": "password123"
}
Login
POST /api/auth/login
{
"email": "john@example.com",
"password": "password123"
}
Get Progress
GET /api/progress
Headers: {
"Authorization": "Bearer <token>"
}
π¨ Frontend Integration
Use the API client in lib/api.ts:
import api from '@/lib/api';
// Login
const result = await api.login('user@example.com', 'password');
// Get progress
const progress = await api.getProgress();
// Get recommendations
const resources = await api.getRecommendedResources();
π‘οΈ Security Features
- JWT-based authentication
- Password hashing with bcrypt
- CORS protection
- Request validation
- Error handling middleware
π¦ Dependencies
- express - Web framework
- mongoose - MongoDB ODM
- jsonwebtoken - JWT authentication
- bcryptjs - Password hashing
- cors - CORS middleware
- dotenv - Environment variables
- joi - Validation
π€ Contributing
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
π License
ISC