Skip to content

anubhavrbbani/NoteHub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoteHub

A student-built vault for class notes - organized, accessible, and easy to share.

Overview

NoteHub is a collaborative web platform that helps students upload, organize, and share class notes by subject. The goal is to make it easier for students to access quality notes, study better, and learn from each other.

Features

  • 📝 Upload and organize class notes by subject
  • 🔍 Search and filter notes easily
  • 👥 Share notes with classmates
  • 💬 Collaborative learning environment
  • 📚 Support for multiple subjects and courses
  • 🎯 Help students who miss class or need extra explanations

Project Structure

NoteHub3/
├── frontend/          # React.js frontend application
│   ├── public/
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   └── App.jsx
│   ├── package.json
│   └── vite.config.js
├── backend/           # Node.js/Express backend API
│   ├── src/
│   │   ├── routes/
│   │   ├── models/
│   │   ├── middleware/
│   │   └── server.js
│   ├── package.json
│   └── .env.example
└── context.md         # Project overview

Tech Stack

Frontend

  • React.js
  • Vite (build tool)
  • Axios (HTTP client)

Backend

  • Node.js
  • Express.js
  • MongoDB (database)
  • JWT (authentication)

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn
  • MongoDB

Installation

Backend

cd backend
npm install
cp .env.example .env
npm start

Frontend

cd frontend
npm install
npm run dev

Contributing

We welcome contributions! Please feel free to submit pull requests or open issues.

License

MIT License

About

fostering a community of notetakers and note sharers

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors