Skip to content

ACKNOWLEDGMENTS.md

Latest commit

 

History

History
229 lines (179 loc) · 8.36 KB

ACKNOWLEDGMENTS.md

File metadata and controls

229 lines (179 loc) · 8.36 KB

Acknowledgments

Study Buddy is built upon the incredible work of many open source projects and contributors. We are deeply grateful to all the developers, maintainers, and communities who have made this project possible.

Original Project

Llama Tutor by Hassan El Mghari (@nutlope)

  • License: MIT
  • Description: The original AI-powered personalized tutor that inspired Study Buddy
  • Our Contribution: Fork with provider abstraction, Electron desktop app, and student-focused enhancements

Core Framework & Build Tools

Next.js

  • Maintainer: Vercel Inc.
  • License: MIT
  • Description: The React framework for production that powers our web application
  • Version: 14.2.3

React

  • Maintainer: Meta (Facebook)
  • License: MIT
  • Description: A JavaScript library for building user interfaces
  • Version: 18.x

Electron

  • Maintainer: OpenJS Foundation
  • License: MIT
  • Description: Build cross-platform desktop apps with JavaScript, HTML, and CSS
  • Version: 36.5.0

TypeScript

  • Maintainer: Microsoft
  • License: Apache-2.0
  • Description: A strongly typed programming language that builds on JavaScript
  • Version: 5.x

UI & Styling

Tailwind CSS

  • Maintainer: Tailwind Labs Inc.
  • License: MIT
  • Description: A utility-first CSS framework for rapidly building custom user interfaces
  • Version: 3.4.1

@tailwindcss/typography

  • Maintainer: Tailwind Labs Inc.
  • License: MIT
  • Description: Beautiful typographic defaults for HTML you don't control
  • Version: 0.5.13

Headless UI for React

  • Maintainer: Tailwind Labs Inc.
  • License: MIT
  • Description: Completely unstyled, fully accessible UI components for React
  • Version: 2.1.2

React Hot Toast

  • Maintainer: Tim Neutkens
  • License: MIT
  • Description: Smoking hot React notifications
  • Version: 2.4.1

React Markdown

  • Maintainer: Titus Wormer
  • License: MIT
  • Description: Markdown component for React
  • Version: 9.0.1

AI & LLM Integration

OpenAI Node.js Library

  • Maintainer: OpenAI
  • License: Apache-2.0
  • Description: The official Node.js library for the OpenAI API
  • Version: 4.52.7

Together AI SDK

  • Maintainer: Together Computer
  • License: MIT
  • Description: TypeScript SDK for Together AI's API
  • Version: 0.6.0-alpha.3

eventsource-parser

  • Maintainer: Espen Hovlandsdal
  • License: MIT
  • Description: A streaming parser for server-sent events/eventsource streams
  • Version: 1.1.2

llama3-tokenizer-js

  • Maintainer: Belladore AI
  • License: MIT
  • Description: JavaScript tokenizer for Llama 3 models
  • Version: 1.1.3

Data Validation & Parsing

Zod

  • Maintainer: Colin McDonnell
  • License: MIT
  • Description: TypeScript-first schema declaration and validation library
  • Version: 3.23.8

zod-to-json-schema

  • Maintainer: Stefan Terdell
  • License: MIT
  • Description: Convert Zod schemas to JSON schemas
  • Version: 3.23.0

Web Scraping & Content Processing

@mozilla/readability

  • Maintainer: Mozilla
  • License: Apache-2.0
  • Description: A standalone version of the readability library used in Firefox Reader Mode
  • Version: 0.5.0

jsdom

  • Maintainer: jsdom Contributors
  • License: MIT
  • Description: A JavaScript implementation of the W3C DOM and HTML standards
  • Version: 24.1.0

Development Tools

Electron Builder

  • Maintainer: Stefan Judis & Contributors
  • License: MIT
  • Description: A complete solution to package and build ready-for-distribution Electron apps
  • Version: 26.0.12

ESLint

  • Maintainer: ESLint Team
  • License: MIT
  • Description: Find and fix problems in your JavaScript code
  • Version: 8.x

Prettier

  • Maintainer: Prettier Team
  • License: MIT
  • Description: An opinionated code formatter
  • Version: 3.2.5

prettier-plugin-tailwindcss

  • Maintainer: Tailwind Labs Inc.
  • License: MIT
  • Description: A Prettier plugin for Tailwind CSS that automatically sorts classes
  • Version: 0.6.0

PostCSS

  • Maintainer: Andrey Sitnik
  • License: MIT
  • Description: A tool for transforming CSS with JavaScript
  • Version: 8.x

concurrently

  • Maintainer: Kimmo Brunfeldt
  • License: MIT
  • Description: Run multiple commands concurrently
  • Version: 9.2.0

cross-env

  • Maintainer: Kent C. Dodds
  • License: MIT
  • Description: Run scripts that set and use environment variables across platforms
  • Version: 7.0.3

get-port

  • Maintainer: Sindre Sorhus
  • License: MIT
  • Description: Get an available port
  • Version: 6.1.2

wait-on

  • Maintainer: Jeff Barczewski
  • License: MIT
  • Description: Wait for files, ports, sockets, and http(s) resources to become available
  • Version: 8.0.3

Type Definitions

We also rely on numerous @types/* packages maintained by the DefinitelyTyped community:

  • @types/node
  • @types/react
  • @types/react-dom
  • @types/jsdom

Special Thanks

Community & Ecosystem

  • Node.js - The JavaScript runtime that makes server-side development possible
  • npm - The package manager that connects all these amazing projects
  • GitHub - For hosting and enabling open source collaboration
  • VS Code - The editor that makes development a joy

AI Providers & Services

  • Ollama - For making local AI accessible to everyone
  • SearXNG - Open source metasearch engine for privacy-focused search
  • OpenAI, Anthropic, Google, Groq, Together AI - For their AI APIs that power cloud-based tutoring

Educational Philosophy

  • The Open Source Community - For proving that collaborative development creates better software
  • All the educators and students who will use this tool to learn and teach

License Compliance

Study Buddy is released under the MIT License, which is compatible with all the dependencies listed above. We ensure full compliance with all upstream licenses and encourage users to review the individual licenses of these projects.

Contributing Back

We believe in giving back to the open source community. Study Buddy contributes by:

  • Demonstrating practical AI application patterns
  • Showing how to build privacy-first educational tools
  • Providing examples of Electron + Next.js integration
  • Creating student-accessible AI tutoring solutions

How to Contribute

If you're interested in contributing to any of these amazing projects:

  1. Visit their GitHub repositories
  2. Read their contribution guidelines
  3. Submit issues, pull requests, or documentation improvements
  4. Consider sponsoring maintainers who make your work possible

Thank you to every developer, maintainer, and contributor who has made Study Buddy possible. Open source is the foundation of innovation, and we're proud to be part of this incredible ecosystem.

If we've missed any attribution or you'd like to update information about your project, please open an issue or pull request.