Skip to content
This repository has been archived by the owner on Nov 18, 2024. It is now read-only.
/ rusty-notes Public archive

A secure, (WIP) cross-platform note-taking application built with Rust. Features end-to-end encryption for cloud sync and a modern React frontend.

Notifications You must be signed in to change notification settings

toolworks-dev/rusty-notes

Repository files navigation

Rusty Notes

A secure, (WIP) cross-platform note-taking application built with Rust. Features end-to-end encryption for cloud sync and a modern React frontend.

image

Features

  • 📝 Markdown editor with live preview
  • 🔄 Secure cloud synchronization
  • 🔐 End-to-end encryption
  • 🌙 Dark/Light mode
  • 💾 Automatic saving
  • 🔍 Full-text search
  • 📱 Cross-platform (Soon) (Mobile is planned)
  • 💾 Import/Export functionality
  • 🔒 Seed phrase-based encryption
  • 🖥️ System tray support

To-Do

  • Mobile support
  • Improved Sync
  • Rich Text
  • Attachments/Files

Installation

Binary

  1. Download the binary from the releases page.
  2. Run the binary.

From Source

Prerequisites

  • Rust (latest stable)
  • Node.js
  • npm

Build

  1. Clone the repository
  2. Run npm install to install the dependencies.
  3. Run npm run tuari build to build the client.

Server Self-Hosting

Prerequisites

  • Docker
  • Docker Compose

Setup

  1. Clone the repository
  2. Run docker compose up --build inside the server directory to build and start the server.

Configuration

Add your ip:port or if reverse proxying, your domain in sync server settings

About

A secure, (WIP) cross-platform note-taking application built with Rust. Features end-to-end encryption for cloud sync and a modern React frontend.

Resources

Stars

Watchers

Forks

Packages

No packages published