Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pubky/pubky-notes
Note taking app using pubky protocol
https://github.com/pubky/pubky-notes
Last synced: about 9 hours ago
JSON representation
Note taking app using pubky protocol
- Host: GitHub
- URL: https://github.com/pubky/pubky-notes
- Owner: pubky
- Created: 2024-09-09T12:54:08.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T07:20:44.000Z (28 days ago)
- Last Synced: 2024-10-28T10:44:44.734Z (23 days ago)
- Language: TypeScript
- Size: 264 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pubky Notes
## Introduction
We’re all used to note-taking apps—Evernote, Google Keep, and others that let us jot down thoughts or create to-do lists. But have you ever wondered who actually owns your notes and what control you have over them? That’s where Pubky Notes comes in. As part of Pubky’s hackweek, we’ve created a simple note-taking app that takes a different approach: you control your data. Built on the Pubky Core protocol, this app makes sure that your notes are stored on your own home-server, giving you full ownership and flexibility.
**Note:** This is a demo app created to demonstrate the capabilities of the Pubky framework and the Tauri-based desktop app. **It is not recommended to use this for real data** as it is only for demonstration purposes.
## Installation
To get started with **Pubky Notes**, follow the steps below:
### Prerequisites
- Install Tauri prerequisites as per the [Tauri documentation](https://tauri.app/start/prerequisites/).
### Steps
1. Clone the repository:
```bash
git clone https://github.com/pubky/pubky-notes.git
```
2. Navigate to the project directory:
```bash
cd pubky-notes
```
3. Install dependencies:
```bash
yarn install
```
4. Run the app in development mode:
```bash
yarn tauri dev
```
5. Build the app for production:
```bash
yarn tauri build
```
## Homeserver
To run a local instance of the testnet homeserver, follow these steps below:
### Steps
1. Clone the `pubky` repository:
```bash
git clone https://github.com/pubky/pubky.git
```
2. Navigate to the directory:
```bash
cd pubky/pubky/pkg
```
3. Install dependencies:
```bash
npm install
```
4. Run the homeserver in testnet mode:
```bash
npm run testnet
```
The **Pubky Notes** desktop app will already be pointed to this server.
## Contribution
Feel free to open an issue or a pull request if you want to contribute to the development of this project. We welcome feedback and suggestions!