https://github.com/rajofearth/study-notes-hub
Study Notes Hub is a user-friendly platform offering quick access to study materials with a sleek design using HTML, CSS, and Tailwind CSS, featuring embedded PDF viewing and easy downloads.
https://github.com/rajofearth/study-notes-hub
pdf-viewer responsive-design study-notes tailwind-css website
Last synced: 2 months ago
JSON representation
Study Notes Hub is a user-friendly platform offering quick access to study materials with a sleek design using HTML, CSS, and Tailwind CSS, featuring embedded PDF viewing and easy downloads.
- Host: GitHub
- URL: https://github.com/rajofearth/study-notes-hub
- Owner: rajofearth
- License: mit
- Created: 2024-08-29T15:21:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-16T12:59:44.000Z (2 months ago)
- Last Synced: 2025-10-17T09:15:09.691Z (2 months ago)
- Topics: pdf-viewer, responsive-design, study-notes, tailwind-css, website
- Language: JavaScript
- Homepage: https://study-notes-hub.vercel.app/
- Size: 133 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📚 Study Notes Hub
[](https://github.com/rajofearth/study-notes-hub/blob/main/LICENSE)
**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](https://rajofearth.github.io/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**:
```bash
git clone https://github.com/rajofearth/study-notes-hub.git
```
2. **Navigate to the project directory**:
```bash
cd study-notes-hub
```
3. **Install dependencies**:
```bash
npm install
```
### Running the Development Server
To start the development server:
```bash
npm run dev
```
This will launch the application at `http://localhost:5173`.
### Building for Production
To create a production build:
```bash
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](https://github.com/rajofearth). For questions or feedback, please reach out via GitHub.
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/rajofearth/study-notes-hub/blob/main/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.
---