Skip to content

Jdaniel98/RonNotes

Repository files navigation

Ron Notes

A local-first, AI-powered note-taking application built with Tauri 2.0, React, and TypeScript.

Features

  • 📝 Markdown-based note editing with TipTap
  • 🔗 Bi-directional linking and knowledge graph
  • 🤖 AI-powered features with Claude integration
  • 🔍 Semantic search with vector embeddings
  • 🎨 Modern UI with TailwindCSS
  • 🔒 Local-first architecture with SQLite

Tech Stack

  • Runtime: Tauri 2.0 (Rust + Web)
  • Frontend: React 19, TypeScript, Vite
  • Styling: TailwindCSS 4
  • Editor: TipTap (ProseMirror)
  • Database: SQLite with Drizzle ORM
  • State: Zustand + Immer
  • AI: Anthropic Claude API
  • Testing: Vitest, Playwright, Testing Library

Getting Started

Prerequisites

Installation

  1. Clone the repository

  2. Install dependencies:

    pnpm install
  3. Copy environment variables:

    cp .env.example .env
  4. Add your Anthropic API key to .env

Development

Start the development server:

pnpm tauri:dev

Run tests:

pnpm test
pnpm test:e2e

Project Structure

See claude.md for detailed project structure and development guidelines.

Commands

Command Description
pnpm dev Start Vite dev server
pnpm build Build frontend for production
pnpm tauri:dev Start Tauri development mode
pnpm tauri:build Build Tauri app for production
pnpm typecheck Run TypeScript type checking
pnpm lint Run ESLint
pnpm format Format code with Prettier
pnpm test Run unit tests
pnpm test:e2e Run E2E tests
pnpm db:generate Generate database migrations
pnpm db:migrate Run database migrations
pnpm db:studio Open Drizzle Studio

Code Conventions

  • TypeScript strict mode enabled
  • Functional React components only
  • Components: PascalCase.tsx
  • Hooks: camelCase.ts with use prefix
  • Utilities: camelCase.ts

See claude.md for comprehensive conventions.

Contributing

See CONTRIBUTING.md for contribution guidelines.

License

MIT

About

A local-first, AI-powered note-taking app built with Tauri, React, and TypeScript. Features a rich markdown editor, bi-directional linking, knowledge graph, and semantic search — all stored on your machine. No cloud required.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages