https://github.com/toolworks-dev/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.
https://github.com/toolworks-dev/rusty-notes
Last synced: 11 months ago
JSON representation
A secure, (WIP) cross-platform note-taking application built with Rust. Features end-to-end encryption for cloud sync and a modern React frontend.
- Host: GitHub
- URL: https://github.com/toolworks-dev/rusty-notes
- Owner: toolworks-dev
- Created: 2024-11-13T14:33:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-13T17:00:21.000Z (over 1 year ago)
- Last Synced: 2024-11-14T08:35:31.369Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 304 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rusty Notes
# Depricated! Use https://github.com/toolworks-dev/trusty-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.
## 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](https://github.com/0xgingi/rusty-notes/releases).
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