https://github.com/ruralad/notedown

Note taking with react + rust. For windows, mac and linux.
https://github.com/ruralad/notedown

notes react rust tauri

Last synced: about 2 months ago
JSON representation

Note taking with react + rust. For windows, mac and linux.

• Host: GitHub
• URL: https://github.com/ruralad/notedown
• Owner: ruralad
• License: mit
• Archived: true
• Created: 2023-03-28T07:03:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-06T14:02:05.000Z (over 1 year ago)
• Last Synced: 2024-08-05T00:06:42.700Z (5 months ago)
• Topics: notes, react, rust, tauri
• Language: TypeScript
• Homepage:
• Size: 1.19 MB
• Stars: 24
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-tauri - Notedown - Minimal, local-first cross-platform note taking app. (Applications / Office & Writing)

README

        






Notedown - a simple, local-first note taking app with tauri




[![Windows Support](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)](https://github.com/ruralad/notedown/releases) [![Ubuntu Support](https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge&logo=ubuntu&logoColor=white)](https://github.com/ruralad/notedown/releases) [![Mac Support](https://img.shields.io/badge/MACOS-adb8c5?style=for-the-badge&logo=macos&logoColor=white)](https://github.com/ruralad/notedown/releases)





[![GitHub package.json version](https://img.shields.io/github/package-json/v/ruralad/notedown?color=%40&label=latest)](https://github.com/ruralad/notedown/releases/latest)

![GitHub issues](https://img.shields.io/github/issues-raw/ruralad/notedown)





![GitHub all releases](https://img.shields.io/github/downloads/ruralad/notedown/total)



## Installation

Notedown is under heavy development, expect a lot of breaking changes till we hit 1.0.

If you want to install Notedown on your system, you can download the installer for your operating system [on the release page](https://github.com/ruralad/notedown/releases).

## Run Locally

Clone the project

```bash

  git clone https://github.com/ruralad/notedown.git

```

Go to the project directory

```bash

  cd notedown

```

Install dependencies

```bash

  pnpm install

```

Note : Follow [this guide](https://tauri.studio/en/docs/getting-started/intro/#setting-up-your-environment) to set up Tauri environment

Start the server

```bash

  pnpm tauri dev

```

## License

Licensed under the [MIT license](https://github.com/ruralad/notedown/blob/main/LICENSE).