/ai-notepad

A research project for analyzing "vibe coding" capabilities. This project is a result of said research.

Primary LanguageTypeScript

AI Notepad

A private, offline-first, and powerful notepad with AI-powered features.

AI Notepad is a secure, client-side application that runs entirely in your browser. It combines a clean, minimalist interface for focused writing with advanced AI assistance. Bring your own API key and enjoy a private writing experience where you control your data.

Read the Full Documentation


Features

  • 📝 Simple & Clean Interface: A minimalist notepad designed for focused writing.
  • 🔒 Secure & Private: All your notes and API keys are stored locally in your browser's Origin Private File System (OPFS). Your data never leaves your machine.
  • 🔌 Offline-First: Works seamlessly without an internet connection. Your notes are always accessible.
  • 🤖 Powerful AI Features:
    • Autocomplete: Let the AI continue your thoughts.
    • Replace Selection: Highlight text and have the AI rewrite it, summarize it, or fill in the blanks.
    • Insert at Cursor: Get AI-generated text right where you need it.
  • 🧠 View AI Thinking Process: See the reasoning behind the AI's suggestions for supported models.
  • ⚙️ Highly Customizable:
    • AI Providers: Switch between OpenAI, Google Gemini, and any custom OpenAI-compatible endpoint.
    • System Prompts: Tailor the AI's behavior with custom instructions for each feature.
    • Parameters: Fine-tune AI creativity with Temperature and Top P controls.
    • Appearance: Customize the font, theme, and layout to your liking.
  • 💾 Auto-Save: Your work is automatically saved as you type.

Tech Stack

  • SvelteKit: A fast and modern web framework for building user interfaces.
  • TypeScript: For type safety and a better developer experience.
  • Vite: A next-generation front-end tooling that provides a faster and leaner development experience.
  • Vitest: A blazing-fast unit-test framework powered by Vite.

Getting Started

Prerequisites

Installation

  1. Clone the repository:
    git clone https://github.com/Levelleor/ai-notepad.git
  2. Install dependencies:
    cd ai-notepad
    npm install
  3. Run the development server:
    npm run dev
  4. Open the app: Navigate to the local address provided in your terminal (e.g., https://localhost:5173).

Configuration

  1. API Keys:
    • Click on the "🔑 API Keys" button in the header.
    • Add your API keys for OpenAI, Gemini, or your custom provider.
  2. Settings:
    • Use the sidebar to configure your preferred font, AI provider, and model.
    • Click the "📝 System Prompts" button to customize the AI's instructions.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue.

For more detailed information, please see our Development Guide.