William Casarin 74c5f0c748 split notedeck into crates
This splits notedeck into crates, separating the browser chrome and
individual apps:

* notedeck: binary file, browser chrome
* notedeck_columns: our columns app
* enostr: same as before

We still need to do more work to cleanly separate the chrome apis
from the app apis. Soon I will create notedeck-notebook to see what
makes sense to be shared between the apps.

Some obvious ones that come to mind:

1. ImageCache

We will likely want to move this to the notedeck crate, as most apps
will want some kind of image cache. In web browsers, web pages do not
need to worry about this, so we will likely have to do something similar

2. Ndb

Since NdbRef is threadsafe and Ndb is an Arc<NdbRef>, it can be safely
copied to each app. This will simplify things. In the future we might
want to create an abstraction over this? Maybe each app shouldn't have
access to the same database... we assume the data in DBs are all public
anyways, but if we have unwrapped giftwraps that could be a problem.

3. RelayPool / Subscription Manager

The browser should probably maintain these. Then apps can use ken's
high level subscription manager api and not have to worry about
connection pool details

4. Accounts

Accounts and key management should be handled by the chrome. Apps should
only have a simple signer interface.

That's all for now, just something to think about!

Signed-off-by: William Casarin <jb55@jb55.com>
2024-12-11 11:24:29 -08:00
2024-12-11 11:24:29 -08:00
2024-11-27 15:45:14 -08:00
2024-11-26 12:39:30 -05:00
2024-12-11 11:24:29 -08:00
2024-12-11 11:24:29 -08:00
2023-07-09 12:29:39 -07:00
2024-11-25 16:42:20 -05:00
2023-07-01 11:25:55 -07:00
2024-02-27 14:26:02 -08:00
2024-11-28 11:51:24 -08:00
2024-04-09 23:05:31 -05:00
2024-05-15 09:40:12 -07:00
2023-07-06 08:40:50 -07:00

Damus Notedeck

CI

A multiplatform nostr client. Works on android and desktop

The desktop client is called notedeck:

notedeck

Android

Look it actually runs on android!

Usage

$ ./target/release/notedeck

Developer Setup

Desktop (Linux/MacOS, Windows?)

If you're running debian-based machine like Ubuntu or ElementaryOS, all you need is to install rustup and run sudo apt install build-essential.

$ cargo run --release 

Android

The dev shell should also have all of the android-sdk dependencies needed for development, but you still need the aarch64-linux-android rustup target installed:

$ rustup target add aarch64-linux-android

To run on a real device, just type:

$ cargo apk run --release

Android Emulator

  • Install Android Studio
  • Open 'Device Manager' in Android Studio
  • Add a new device with API level 34 and ABI arm64-v8a (even though the app uses 30, the 30 emulator can't find the vulkan adapter, but 34 works fine)
  • Start up the emulator

while the emulator is running, run:

cargo apk run --release

The app should appear on the emulator

Previews

You can preview individual widgets and views by running the preview script:

./preview RelayView
./preview ProfilePreview
# ... etc

When adding new previews you need to implement the Preview trait for your view/widget and then add it to the src/ui_preview/main.rs bin:

previews!(runner, name,
    RelayView,
    AccountLoginView,
    ProfilePreview,
);

Contributing

Configure the developer environment:

./scripts/dev_setup.sh

This will add the pre-commit hook to your local repository to suggest proper formatting before commits.

Description
A multiplatform nostr client
Readme 28 MiB
Languages
Rust 83.1%
Fluent 13.5%
Python 1.5%
Java 0.8%
Shell 0.3%
Other 0.7%