{"id":23586802,"url":"https://github.com/ramxcodes/notes-buddy","last_synced_at":"2025-11-03T11:30:28.432Z","repository":{"id":269702974,"uuid":"908014770","full_name":"ramxcodes/notes-buddy","owner":"ramxcodes","description":"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.","archived":false,"fork":false,"pushed_at":"2025-02-05T14:15:38.000Z","size":10412,"stargazers_count":8,"open_issues_count":0,"forks_count":13,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-05T15:28:35.731Z","etag":null,"topics":["mdx","nextjs14","open-source","react"],"latest_commit_sha":null,"homepage":"https://notesbuddy.in","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ramxcodes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-24T21:50:56.000Z","updated_at":"2025-02-05T14:15:41.000Z","dependencies_parsed_at":"2025-02-05T15:24:28.696Z","dependency_job_id":"c6c7788d-2044-4cf7-a652-08f15e02e164","html_url":"https://github.com/ramxcodes/notes-buddy","commit_stats":null,"previous_names":["ramxcodes/notes-buddy"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramxcodes%2Fnotes-buddy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramxcodes%2Fnotes-buddy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramxcodes%2Fnotes-buddy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramxcodes%2Fnotes-buddy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ramxcodes","download_url":"https://codeload.github.com/ramxcodes/notes-buddy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239412444,"owners_count":19634016,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mdx","nextjs14","open-source","react"],"created_at":"2024-12-27T04:14:12.116Z","updated_at":"2025-11-03T11:30:28.327Z","avatar_url":"https://github.com/ramxcodes.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notes Buddy\n\nWelcome to **Notes Buddy**, a web platform designed for students to read and share college notes easily. \nBuilt with a modern tech stack, it ensures an easy-to-use, visually appealing, and responsive experience. \n\n![Notes Buddy](https://i.imgur.com/REQIqc2.jpeg)\n\n---\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Features](#features)\n- [Top Contributing](#top-contributing)\n- [Contributing](#contributing)\n- [Stats](#stats)\n- [Tech Stack](#tech-stack)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Folder Structure](#folder-structure)\n\n---\n\n## Introduction\n\n**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.\n\n\n## Features\n\n- **MDX Notes**: Each page is powered by MDX, combining Markdown and React components.\n- **Theming**: Supports dynamic light/dark mode with `next-themes`.\n- **Responsive Design**: Built with Tailwind CSS for mobile-first design.\n- **Modern Navigation**: Radix UI-powered components for an intuitive experience.\n- **Code Highlighting**: Notes include syntax highlighting for code snippets using `rehype-pretty-code`.\n\n## Top Contributors\n\n\u003ca href=\"https://github.com/ramxcodes/notes-buddy/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=ramxcodes/notes-buddy\" /\u003e\n\u003c/a\u003e\n\n## Contributing\n\nContributions are welcome! Feel free to:\n- Visit Here for Collaboration Guide :\n    https://notes-buddy.ramx.in/notes/github/contribution-guide\n- Open issues for bug reports or feature requests.\n- Fork the repository, make changes, and submit pull requests.\n\n\n## Stats\n\n![Alt](https://repobeats.axiom.co/api/embed/ec5a9573541499a183fc9597f74d3cc63ddf4079.svg \"Repobeats analytics image\")\n\n\n## Tech Stack\n\n**Frontend**:\n- React\n- Next.js\n\n**Styling**:\n- Tailwind CSS\n- `@tailwindcss/typography`\n\n**UI Components**:\n- Radix UI\n- Shadcn\n\n**Build Tools**:\n- TypeScript\n- PostCSS\n- ESLint\n\n\n## Installation\n\nFollow these steps to set up the project locally:\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/ramxcodes/notes-buddy.git\n   cd notes-buddy\n   ```\n\n2. Install dependencies:\n   ```bash\n   pnpm install\n   ```\n\n3. Run the development server:\n   ```bash\n   pnpm run dev\n   ```\n\n4. Open [http://localhost:3000](http://localhost:3000) in your browser.\n\n\n## Folder Structure\n\nHere’s a brief overview of the folder structure:\n\n```\n.\n├── app               # Application logic\n├── assets            # Static assets\n├── components        # Reusable components\n├── config            # Configuration files\n├── content           # MDX notes content\n├── hooks             # Custom React hooks\n├── lib               # Utility libraries\n├── public            # Public assets\n├── styles            # Global CSS and Tailwind setup\n├── utils             # Helper functions\n├── .vscode           # Editor settings\n├── package.json      # Project metadata and scripts\n├── README.md         # Project documentation\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Framxcodes%2Fnotes-buddy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Framxcodes%2Fnotes-buddy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Framxcodes%2Fnotes-buddy/lists"}