JeremiasVillane/open-note

A simple desktop application for taking rich text notes, built with Tauri and React, and written in Rust and TypeScript.

English | Español

Open Note ^alpha

Tauri + React + Typescript

          

---

A simple note-taking desktop application to create rich text notes, built with Tauri and React, and written in TypeScript and Rust.

Open Note is in alpha

Currently, Open Note is still in alpha, which means that there may be incompatible version updates, and it is recommended to use it if you have backed up your data.

Key Features

• Create, edit and delete notes/folders.
• Rich text editor powered by TipTap.
• Organize notes into folders and subfolders.
• Export notes in pdf format.
• Multilingual (currently English and Spanish).
• Light/dark theme.
• Status bar showing characters, letters, word and line count, and system messages.
• Global hotkeys to control the main functions via keyboard.
• Resizable panel for exploring the file system.
• Use of Tauri commands (written in Rust) to interact with the OS file system.
• Use of Tauri multiwindow functionality to implement custom modals.
• Use of Tauri events to pass information between windows.

Project Roadmap

• Export notes in pdf format.
• Drag & Drop notes in folders.
• Tagging system.
• Search notes.
• Insert images.
• Code highlighting.
• Automatic updates.
• Persistent config file.
• Cloud sync.
• Note encryption.

Download

Go to the release page.

Techstack

• Tauri: a toolkit to build cross-platform apps.
• React with Vite.
• Mantine for the app layout.
• TipTap for the rich text editor.
• Zustand for state management.
• Tailwind CSS for the app styling.
• react-i18next: a powerful internationalization framework based on i18next.
• React-pdf: React renderer for creating PDF files.
• TypeScript for type safety.
• Rust for the base infrastructure of the app.

How to run or build from source

Prerequisites

• NodeJS
• npm
• Cargo

Step 1: Clone the project repository to your computer

• Open a terminal and run the following command to clone the project from GitHub to your computer:

git clone https://github.com/JeremiasVillane/open-note.git

Step 2: Install the dependencies

• Open a terminal and navigate to the Open Note project directory.
• Use npm to install the dependencies:

cd open-note
npm install

Step 3: Install Tauri

• Visit the https://tauri.app/v1/guides/getting-started/prerequisites/ page to find Tauri installation instructions.

Step 4: Run or build

• Navigate to the Open Note project directory.
• Use npm to run in dev mode:

npm run tauri dev

• Or build from source:

npm run tauri build

License

Distributed under the MIT License.

Support

If you would like to support Open Note, please star this project. Your support is greatly appreciated.

Contact me

• LinkedIn