Study Notes Hub

Study Notes Hub is a web-based platform designed to provide easy access to study notes for various subjects. It features a user-friendly interface for browsing and viewing notes, supporting both regular and handwritten notes across different semesters.

Live Website

Access the live site at Study Notes Hub.

Key Features

• Browse and view study notes organized by subjects and semesters
• Toggle between regular and handwritten notes
• Dark mode support for better readability
• Responsive design compatible with mobile and desktop
• Integrated PDF viewer for seamless note viewing
• Search functionality to quickly find subjects and notes

Technologies Used

• React for building the UI
• Vite as the build tool
• Tailwind CSS for modern styling
• shadcn/ui components for a refined user experience
• React Router for client-side routing
• PDF.js for rendering PDF notes

Getting Started

Prerequisites

• Node.js (v14+)
• npm (bundled with Node.js)

Installation

1. Clone the repository:

   git clone https://github.com/rajofearth/study-notes-hub.git
   

2. Navigate to the project directory:

   cd study-notes-hub
   

3. Install dependencies:

   npm install
   

Running the Development Server

To start the development server:

npm run dev

This will launch the application at http://localhost:5173.

Building for Production

To create a production build:

npm run build

The optimized files will be located in the dist directory.

Usage Guide

• Home Page: Browse through available subjects and use the search bar for specific topics.
• Subject Page: Select a semester, choose between regular or handwritten notes, and view/download the PDFs.
• Theme Toggle: Switch between light and dark modes using the theme toggle button in the header.

Screenshots

(Add screenshots of your application to showcase key features)

Contributing

We welcome contributions! Feel free to submit a Pull Request or create an Issue for any suggestions or improvements.

Contact

Developed by Yashraj Maher. For questions or feedback, please reach out via GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Thank you for exploring Study Notes Hub! Enhance your learning journey with easy access to valuable resources.

Additional Configuration Files

• Package Configuration (package.json): Defines dependencies, scripts, and settings for the project.
• Vite Configuration (vite.config.js): Configures Vite with plugins, build options, and custom middleware.
• Main Application Component (src/App.jsx): Sets up routing, theme provider, and the main component structure.