Skip to content

(Work in Progress) Tauri Based Text Editor with React Frontend and Crab (rust)! that I hopefully not abandoning

Notifications You must be signed in to change notification settings

FelixFern/Crabitor

Repository files navigation

🦀 Crabitor

a Rust + React Markdown Editor, this project is my first ever writing in Rust so please excuse the badly written code 😅.

You might be wondering why don't you write the Frontend in Rust too. the main reason is that I just want to build this project quickly without thinking that much on the UI side, that's why I build it with React with Shadcn even though it might not be as performant as building it using Rust with frameworks such as Leptos.

Why is it named "Crabitor"? because it is Crab-itor, Crab, and editor, get it? because it is written in Rust with a Crab icon. Yes, I'm very creative.

This project is started on April 17th, 2024, and is worked on in my spare time

image image image

🗒️ Prerequisites

  • Node.js version 18 and up with package manager (npm, pnpm, yarn, or bun)
  • Rust with Cargo

Tech Stack

  • Rust
  • Typescript
  • React.js
  • Tauri
  • Shadcn - Component Library
  • Recoil - Client Side State Library
  • Tiptap - WYSIWYG Editor

How to Run ?

  1. Git clone this repository with
    git clone https://github.com/FelixFern/Crabitor
    
  2. Install all the needed dependencies with
    pnpm i
    
  3. Run the project and enjoy
    pnpm tauri dev
    

🟢 Current Feature

  • Live File Save ✅
  • Create New Note ✅
  • Update Note Name ✅
  • Edit Note ✅
  • Switch Between File with Hotkeys (cmd + [number]) ✅
  • Markdown Support ✅
  • Quick Command (cmd + shift + p) ✅
  • Delete Note (Still Buggy) 🟧

🟠 Todos

  • Folder
  • Expandable Sidebar

🙎‍♂️ Maintained by

About

(Work in Progress) Tauri Based Text Editor with React Frontend and Crab (rust)! that I hopefully not abandoning

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published