Skip to content

sb-byte/Notes-Aid

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š Notes-Aid

A modern platform to access academic notes with embedded YouTube videos and PDFs for better learning! πŸš€

✨ Features

βœ… Curated Study Materials – Well-structured notes, textbooks and previous year questions for various subjects.
βœ… YouTube Video Integration – Directly watch relevant tutorials.
βœ… PDF Resources – Downloadable and easy-to-read notes.


πŸ‘₯ Contributors

We appreciate the contributions of our amazing team:

πŸ™Œ Feel free to contribute and improve Notes-Aid!


πŸ“‚ Project Structure

πŸ“‚ notes-aid
β”œβ”€β”€ πŸ“‚ public
β”‚   β”œβ”€β”€ πŸ“‚ icons
β”œβ”€β”€ πŸ“‚ src
β”‚   β”œβ”€β”€ πŸ“‚ app
β”‚   β”‚   β”œβ”€β”€ πŸ“‚ api/auth
β”‚   β”‚   β”œβ”€β”€ πŸ“‚ [year]/[branch]/[semester]
β”‚   β”‚   β”œβ”€β”€ πŸ“‚ edit
β”‚   β”‚   β”‚   β”œβ”€β”€ πŸ“‚ editor
β”‚   β”‚   β”‚   β”œβ”€β”€ πŸ“‚ login
β”‚   β”œβ”€β”€ πŸ“‚ components
β”‚   β”‚   πŸ“‚ interfaces
β”‚   β”‚   πŸ“‚ metrics
β”‚   β”‚   πŸ“‚ notes
β”‚   β”‚   β”œβ”€β”€ πŸ“‚ fy, sy, ty
β”‚   β”‚   β”‚   β”œβ”€β”€ πŸ“‚ comps (evenSem, oddSem)
β”‚   β”‚   β”‚   β”œβ”€β”€ πŸ“‚ it (evenSem, oddSem)
β”‚   β”‚   

πŸš€ Get Started

1️⃣ Clone the repository:

git clone https://github.com/MinavKaria/Notes-Aid.git
cd notes-aid

2️⃣ Install dependencies:

npm install

3️⃣ Run the development server:

npm run dev

4️⃣ Open in browser:

http://localhost:3000

πŸ“’ Contributing

Want to improve Notes-Aid? Follow these steps:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes & commit
  4. Open a pull request

Your contributions are always welcome! πŸŽ‰


This version enhances readability, improves structure, and provides clear information. πŸš€ Let me know if you'd like any more tweaks!

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.0%
  • Python 2.6%
  • Other 0.4%