Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

55 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š EduFlow

A student productivity platform for managing notes, resources, and tasks β€” all in one place.

Built with React, Node.js, Express.js, and MongoDB. πŸ† Originally developed for the Open Source Hackathon organized by Elite Coders.

Stars Forks Issues License PRs Welcome

⭐ Star this repo if you find it useful β€” it helps a lot and takes 2 seconds!


✨ Why EduFlow?

Juggling notes, resources, and to-dos across five different apps is exhausting. EduFlow brings it all into a single, clean workspace built specifically for students β€” so you can focus on studying, not on managing tools.

πŸš€ Features

  • πŸ“ Notes β€” create, organize, and manage study notes
  • πŸ“‚ Resources β€” store and access learning material in one place
  • βœ… Tasks β€” track assignments and deadlines
  • πŸ” Authentication β€” secure user accounts
  • πŸ’» Full-stack β€” React frontend + Express/Node.js backend + MongoDB

πŸ› οΈ Tech Stack

Layer Technology
Frontend React
Backend Node.js, Express.js
Database MongoDB
Auth JWT

⚑ Getting Started

Prerequisites

  • Node.js (v18+ recommended)
  • MongoDB (local or Atlas)
  • npm or yarn

Installation

# 1. Clone the repo
git clone https://github.com/Parthwebde12/EduFlow.git
cd EduFlow

# 2. Install backend dependencies
cd backend
npm install

# 3. Install frontend dependencies
cd ../frontend
npm install

Environment Variables

Copy .env.example to .env in the backend folder and fill in your values:

cp .env.example .env

Run locally

# In /backend
npm run dev

# In /frontend (separate terminal)
npm run dev

The app should now be running locally ,check your terminal output for the exact ports.

🀝 Contributing

Contributions are what make the open-source community amazing! Whether it's fixing a bug, adding a feature, or improving docs β€” all contributions are welcome.

  1. Fork the repo
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

See CONTRIBUTING.md for full guidelines, and check out the good first issues if you're new here.

πŸ—ΊοΈ Roadmap

  • Dark mode
  • File attachments for notes
  • Reminders / notifications for tasks
  • Mobile-responsive UI polish
  • Deployed live demo link

Have an idea? Open a feature request!

πŸ› Found a bug?

Please open an issue with steps to reproduce it. See SECURITY.md for reporting security vulnerabilities privately.

πŸ“„ License

This project is licensed under the MIT License.

πŸ™Œ Show your support

If EduFlow helped you or you like where it's headed, please consider giving it a ⭐ star β€” it genuinely helps the project get discovered and motivates continued development!

About

EduFlow is a student productivity platform for managing notes, resources, and tasks in one place. Built with React, Node.js, Express.js, and MongoDB. πŸ† Developed for the Open Source Hackathon organized by Elite Coders.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages