Skip to content

wasir-sadaf/StudyPal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

StudyPal

StudyPal is a full-stack student productivity SaaS platform with task management, rich notes, AI study tools, calendar planning, finance tracking, habit analytics, and a responsive dashboard experience.

Stack

  • Frontend: React 18, Vite, TailwindCSS, React Router, Axios, FullCalendar, React Quill, Chart.js
  • Backend: Node.js, Express, MongoDB, Mongoose, JWT, OpenAI API

Project Structure

frontend/  React application
backend/   Express API

Local Development

  1. Create backend/.env from backend/.env.example
  2. Create frontend/.env from frontend/.env.example
  3. Install dependencies in both apps:
    • cd backend && npm install
    • cd frontend && npm install
  4. Run the backend: npm run dev
  5. Run the frontend: npm run dev

Production Notes

  • Configure a real MongoDB connection string
  • Set a strong JWT_SECRET
  • Add a valid OPENAI_API_KEY
  • Deploy frontend and backend separately with matching VITE_API_URL and CLIENT_URL

Default Ports

  • Frontend: 5173
  • Backend: 5001

Database Modes

  • For local development without MongoDB installed, set USE_IN_MEMORY_DB=true in backend/.env
  • For persistent data, set USE_IN_MEMORY_DB=false and point MONGODB_URI at a real MongoDB instance

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors