Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeremiasvillane/open-note
A simple desktop application for taking rich text notes, built with Tauri and React, and written in Rust and TypeScript.
https://github.com/jeremiasvillane/open-note
mantine mantine-ui notes react reactjs rust rust-lang tailwindcss tauri tauri-app tiptap typescript vitejs zustand
Last synced: about 12 hours ago
JSON representation
A simple desktop application for taking rich text notes, built with Tauri and React, and written in Rust and TypeScript.
- Host: GitHub
- URL: https://github.com/jeremiasvillane/open-note
- Owner: JeremiasVillane
- License: mit
- Created: 2023-11-14T02:26:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-19T00:14:30.000Z (about 1 year ago)
- Last Synced: 2024-05-04T00:17:48.800Z (9 months ago)
- Topics: mantine, mantine-ui, notes, react, reactjs, rust, rust-lang, tailwindcss, tauri, tauri-app, tiptap, typescript, vitejs, zustand
- Language: TypeScript
- Homepage:
- Size: 3.98 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
English | Español
Open Note alpha
[](https://github.com/jeremiasvillane/open-note/blob/main/LICENSE)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FJeremiasVillane%2Fopen-note?ref=badge_shield)
[](https://github.com/prettier/prettier)
### Tauri + React + Typescript
---
A simple note-taking desktop application to create rich text notes, built with [Tauri](https://tauri.app/) and [React](https://react.dev/), and written in [TypeScript](https://www.typescriptlang.org/) and [Rust](https://www.rust-lang.org/).
## 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](https://tiptap.dev/).
- 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](https://www.rust-lang.org/)) 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
- [x] 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](https://github.com/JeremiasVillane/open-note/releases/latest).
## Techstack
- [Tauri](https://tauri.app/): a toolkit to build cross-platform apps.
- [React](https://react.dev/) with [Vite](https://github.com/vitejs/vite).
- [Mantine](https://mantine.dev/) for the app layout.
- [TipTap](https://tiptap.dev/) for the rich text editor.
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) for state management.
- [Tailwind CSS](https://tailwindcss.com/) for the app styling.
- [react-i18next](https://react.i18next.com/): a powerful internationalization framework based on i18next.
- [React-pdf](https://react-pdf.org/): React renderer for creating PDF files.
- [TypeScript](https://www.typescriptlang.org/) for type safety.
- [Rust](https://www.rust-lang.org/) for the base infrastructure of the app.
## How to run or build from source
### Prerequisites
- [NodeJS](https://nodejs.org/)
- [npm](https://www.npmjs.com/)
- [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
### 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/](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**](LICENSE).
[](https://app.fossa.com/projects/git%2Bgithub.com%2FJeremiasVillane%2Fopen-note?ref=badge_large)
## Support
If you would like to support Open Note, please star this project. Your support is greatly appreciated.
## Contact me
- [LinkedIn](https://snppr.vercel.app/2Vt7W2xMe)