refine notes

google docs replacement for meeeeee. rich text, live sharing, pretty much everything you'd want. made it cause notion sucks

Comment

/**

  • README.md - Updated with keyboard shortcuts information
  • Changes:
  • - Added a new section about keyboard shortcuts
  • - Listed common shortcuts for navigation and editing
  • - Added information about the keyboard shortcuts help dialog
  • - Updated to include accessing shortcuts from the settings page */

Notes App

A modern note-taking application with AI-powered features.

Features

  • Text-based note creation and editing with rich formatting
  • Folder organization for notes
  • Image to notes conversion using AI
  • Audio to notes conversion using AI (upload files, record, or paste YouTube links)
  • Flashcard generation from notes
  • Dark and light mode support
  • Multiple theme options
  • Responsive design
  • Comprehensive keyboard shortcuts

Installation

  1. Clone the repository
  2. Install dependencies: npm install
  3. YouTube Processing: Set up the environment variable for the custom microservice:
    • Add your microservice API key to environment variables: YOUTUBE_SERVICE_API_KEY=your_api_key_here
    • The application is configured to use a dedicated microservice at 146.190.2.164:81
  4. Set up environment variables (see .env.example)
  5. Start the development server: npm run dev

Technology Stack

  • Next.js for frontend and API routes
  • React for UI components
  • TypeScript for type safety
  • Tailwind CSS for styling
  • Supabase for database and authentication
  • OpenAI API for AI features
  • TipTap for rich text editing

AI Features

Image to Notes

Upload images (screenshots, photos of documents) and convert them to structured notes.

Audio to Notes

Process audio from three different sources:

  • Upload audio files (lectures, meetings)
  • Record audio directly in the browser
  • Paste YouTube URLs to transcribe and convert to notes

Flashcard Generation

Automatically generate study flashcards from note content.

Keyboard Shortcuts

The app includes a comprehensive keyboard shortcuts system for efficient navigation and editing:

Global Shortcuts

  • B - Toggle folder sidebar
  • E - Toggle editor sidebar
  • Ctrl+/ or ⌘+/ - Show keyboard shortcuts help
  • Ctrl+, or ⌘+, - Open settings page
  • Ctrl+S or ⌘+S - Save current note
  • Ctrl+N or ⌘+N - Create new note
  • Ctrl+F or ⌘+F - Search notes
  • Ctrl+Shift+T or ⌘+Shift+T - Toggle dark/light theme
  • Alt+1 - Go to All Notes
  • Alt+2 - Go to Uncategorized Notes

Editor Shortcuts

  • Ctrl+B or ⌘+B - Bold text
  • Ctrl+I or ⌘+I - Italic text
  • Ctrl+U or ⌘+U - Underline text
  • Ctrl+` or ⌘+` - Code formatting
  • Ctrl+Shift+1 or ⌘+Shift+1 - Heading 1
  • Ctrl+Shift+2 or ⌘+Shift+2 - Heading 2
  • Ctrl+Shift+3 or ⌘+Shift+3 - Heading 3

A complete list of shortcuts is available by pressing Ctrl+/ or ⌘+/ while using the app, or by visiting the Settings page and clicking on "View Keyboard Shortcuts" under the Preferences tab.

Configuration

The app uses environment variables for configuration. See the .env.example file for required variables.

License

MIT

Built With

Share this project:

Updates