🌟 ReviseHub

---

Overview

ReviseHub is a modern, intuitive study management web app built using the MERN stack (MongoDB, Express.js, React, Node.js). It helps students efficiently organize notes, plan study sessions, and track progress — all in one place. Designed for simplicity and productivity, ReviseHub ensures a smooth, distraction-free experience for effective learning and revision.

---

Screenshots

Dashboard      Notes Page


Planner Page      Progress Page

---

🌐 Live Demo (click to try now!)

---

Table of Contents

• Features
• Tech Stack
• Getting Started
• Local Development URLs
• Deployment
• Usage Guide
• Contributing
• License
• Contact
• FAQ

---

Features

• Dashboard – Overview of progress, tasks, and recent activities
• Notes Management – Organize study resources with Cloudinary storage
• Study Planner – Add/manage tasks, track deadlines, maintain consistency
• Progress Tracker – Visualize performance and study trends
• Revision Tracker – Monitor revision frequency
• Authentication – Secure JWT-based login & password reset
• Responsive UI – Optimized for desktop, tablet, and mobile

---

Tech Stack

Category	Technologies
Frontend	React.js, Vite, CSS3
Backend	Node.js, Express.js
Database	MongoDB (Mongoose)
Authentication	JWT (JSON Web Token)
File Storage	Cloudinary
Hosting	Vercel (Frontend), Render (Backend)

---

Getting Started

Prerequisites

• Node.js (v14+ recommended)
• MongoDB (local or cloud, e.g. Atlas)
• npm or yarn

Installation

1. Clone the repository

   git clone https://github.com/Faizan-9077/reviseHub.git
   cd reviseHub

2. Install backend dependencies

   cd backend
   npm install
   # or
   yarn install

3. Install frontend dependencies

   cd ../frontend
   npm install
   # or
   yarn install

4. Configure environment variables
   Copy .env.example to .env in the backend folder, then update values:

   MONGO_URI=your-mongodb-connection-string
   JWT_SECRET=your-secret-key
   PORT=5000
   CLOUDINARY_CLOUD_NAME=your-cloud-name
   CLOUDINARY_API_KEY=your-api-key
   CLOUDINARY_API_SECRET=your-api-secret
   

5. Start the backend server

   cd ../backend
   npm run dev
   # or
   yarn dev

   The backend runs at http://localhost:5000

6. Start the frontend

   cd ../frontend
   npm run dev
   # or
   yarn dev

   The frontend runs at http://localhost:5173

---

Local Development URLs

Service	URL
Backend API	http://localhost:5000
Frontend App	http://localhost:5173

---

Deployment

Service	Environment	URL
Backend API (Render)	Production	https://revisehub-backend.onrender.com
Frontend App (Vercel)	Production	https://revise-hub.vercel.app/
Backend (Local Dev)	Development	http://localhost:5000
Frontend (Local Dev)	Development	http://localhost:5173

---

Usage Guide

1. Register or Login to access features
2. Manage Notes – Upload, tag, and organize notes
3. Plan Tasks – Add study tasks, set priorities
4. Track Progress – Monitor completion stats
5. Reset Password – Securely recover access anytime

---

Contributing

Contributions are welcome! Please:

1. Fork this repository
2. Create a feature branch

   git checkout -b feature/your-feature

3. Commit changes

   git commit -m "Add your feature"

4. Push & submit a Pull Request 🚀

Please write clear commit messages and add tests for new features.

---

License

Licensed under the MIT License.

---

Contact

👤 Faizan
🔗 GitHub
📧 For queries or collaboration, open an issue!

---

FAQ

Q: Why is my Cloudinary upload failing?
A: Check your .env for correct Cloudinary credentials.

Q: How do I report a bug?
A: Open an issue.

---

“Learn smarter, revise better — with ReviseHub.”

---