https://github.com/ramxcodes/notes-buddy
Welcome to Notes Buddy, a web platform designed for students to read and share college notes easily. Built with a modern tech stack, it ensures an easy-to-use, visually appealing, and responsive experience.
https://github.com/ramxcodes/notes-buddy
mdx nextjs14 open-source react
Last synced: 3 months ago
JSON representation
Welcome to Notes Buddy, a web platform designed for students to read and share college notes easily. Built with a modern tech stack, it ensures an easy-to-use, visually appealing, and responsive experience.
- Host: GitHub
- URL: https://github.com/ramxcodes/notes-buddy
- Owner: ramxcodes
- License: mit
- Created: 2024-12-24T21:50:56.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-05T14:15:38.000Z (3 months ago)
- Last Synced: 2025-02-05T15:28:35.731Z (3 months ago)
- Topics: mdx, nextjs14, open-source, react
- Language: MDX
- Homepage: https://notesbuddy.in
- Size: 9.93 MB
- Stars: 8
- Watchers: 0
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Notes Buddy
Welcome to **Notes Buddy**, a web platform designed for students to read and share college notes easily.
Built with a modern tech stack, it ensures an easy-to-use, visually appealing, and responsive experience.
---
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Top Contributing](#top-contributing)
- [Contributing](#contributing)
- [Stats](#stats)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Usage](#usage)
- [Folder Structure](#folder-structure)
---
## Introduction
**Notes Buddy** is a platform for students to access well-structured, MDX-based notes tailored to their courses. It's lightweight, fast, and optimized for readability and accessibility.
## Features
- **MDX Notes**: Each page is powered by MDX, combining Markdown and React components.
- **Theming**: Supports dynamic light/dark mode with `next-themes`.
- **Responsive Design**: Built with Tailwind CSS for mobile-first design.
- **Modern Navigation**: Radix UI-powered components for an intuitive experience.
- **Code Highlighting**: Notes include syntax highlighting for code snippets using `rehype-pretty-code`.
## Top Contributors
## Contributing
Contributions are welcome! Feel free to:
- Visit Here for Collaboration Guide :
https://notes-buddy.ramx.in/notes/github/contribution-guide
- Open issues for bug reports or feature requests.
- Fork the repository, make changes, and submit pull requests.
## Stats
## Tech Stack
**Frontend**:
- React
- Next.js
**Styling**:
- Tailwind CSS
- `@tailwindcss/typography`
**UI Components**:
- Radix UI
- Shadcn
**Build Tools**:
- TypeScript
- PostCSS
- ESLint
## Installation
Follow these steps to set up the project locally:
1. Clone the repository:
```bash
git clone https://github.com/ramxcodes/notes-buddy.git
cd notes-buddy
```
2. Install dependencies:
```bash
pnpm install
```
3. Run the development server:
```bash
pnpm run dev
```
4. Open [http://localhost:3000](http://localhost:3000) in your browser.
## Folder Structure
Here’s a brief overview of the folder structure:
```
.
├── app # Application logic
├── assets # Static assets
├── components # Reusable components
├── config # Configuration files
├── content # MDX notes content
├── hooks # Custom React hooks
├── lib # Utility libraries
├── public # Public assets
├── styles # Global CSS and Tailwind setup
├── utils # Helper functions
├── .vscode # Editor settings
├── package.json # Project metadata and scripts
├── README.md # Project documentation
```