alanagoyal  by alanagoyal

macOS-inspired personal website app simulating a desktop environment

Created 1 year ago
268 stars

Top 96.0% on SourcePulse

GitHubView on GitHub
Project Summary

<2-3 sentences summarising what the project addresses and solves, the target audience, and the benefit.> This project presents an Apple-inspired personal website, meticulously recreating a macOS Sierra 10.12 desktop environment within a web browser. It targets developers and users seeking a highly interactive, visually rich personal portfolio or web application showcase, offering a functional desktop metaphor with multiple integrated applications.

How It Works

The architecture leverages Next.js App Router, rendering a full desktop environment with draggable, resizable windows on larger screens, transitioning to fullscreen apps on mobile. Notes utilize a session-based system with Supabase for persistence, featuring public caching via Incremental Static Regeneration (ISR) and real-time private notes. Messaging is entirely client-side, storing conversations in localStorage and using a Braintrust proxy for OpenAI-compatible AI chat responses, prioritizing user privacy and minimizing server load.

Quick Start & Requirements

  • Installation: Clone the repository (git clone https://github.com/alanagoyal/alanagoyal) and install dependencies (npm install).
  • Prerequisites: A Supabase project (PostgreSQL database) and a Braintrust API key are required for notes and AI chat, respectively. An optional GITHUB_TOKEN can be set to mitigate API rate limits for GitHub integrations.
  • Configuration: Set up a .env.local file with NEXT_PUBLIC_SUPABASE_URL, NEXT_PUBLIC_SUPABASE_ANON_KEY, and BRAINTRUST_API_KEY. Optional variables include NEXT_PUBLIC_SITE_URL and revalidation tokens.
  • Run: Execute npm run dev to start the development server locally at http://localhost:3000.
  • Links: Repository: https://github.com/alanagoyal/alanagoyal

Highlighted Details

  • Full macOS Sierra 10.12 themed desktop environment with window management, dock, and functional menu/status bars.
  • Integrated applications: Notes (GFM, task lists, image upload), Messages (AI contacts, reactions, ⌘K command menu), iTerm (terminal emulator with file system navigation and GitHub integration), Finder (file browser), and Settings (system preferences).
  • Mobile-responsive design with touch-optimized controls and swipe gestures.
  • AI-powered chat functionality using OpenAI-compatible endpoints via Braintrust.
  • Interactive GitHub Flavored Markdown support for notes, including task lists and tables.

Maintenance & Community

The provided README does not contain specific details regarding notable contributors, community channels (e.g., Discord, Slack), roadmap, sponsorships, or partnerships.

Licensing & Compatibility

Licensed under the permissive MIT License. This license generally allows for commercial use and integration into closed-source projects without significant restrictions.

Limitations & Caveats

The AI chat functionality relies on external API keys and client-side processing. Public note caching requires manual revalidation or redeployment to ensure freshness. GitHub integration performance is dependent on the presence of a GITHUB_TOKEN to avoid rate limiting.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
18
Issues (30d)
0
Star History
6 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.