Notedeck

A modern, multiplatform Nostr client built with Rust. Notedeck provides a feature-rich experience for interacting with the Nostr protocol on both desktop and Android platforms.

✨ Features

• Multi-column Layout: TweetDeck-style interface for viewing different Nostr content
• Dave AI Assistant: AI-powered assistant that can search and analyze Nostr content
• Profile Management: View and edit Nostr profiles
• Media Support: View and upload images with GIF support
• Lightning Integration: Zap (tip) content creators with Bitcoin Lightning
• Cross-platform: Works on desktop (Linux, macOS, Windows) and Android

📱 Mobile Support

Notedeck runs smoothly on Android devices with a responsive interface:

🏗️ Project Structure

notedeck
├── crates
│   ├── notedeck           - Core library with shared functionality
│   ├── notedeck_chrome    - UI container and navigation framework
│   ├── notedeck_columns   - TweetDeck-style column interface
│   ├── notedeck_dave      - AI assistant for Nostr
│   ├── notedeck_ui        - Shared UI components
│   └── tokenator          - String token parsing library

🚀 Getting Started

Desktop

To run on desktop platforms:

# Development build
cargo run -- --debug

# Release build
cargo run --release

Android

For Android devices:

# Install required target
rustup target add aarch64-linux-android

# Build and install on connected device
cargo apk run --release -p notedeck_chrome

Android Emulator

1. Install Android Studio
2. Open 'Device Manager' and create a device with API level 34 and ABI arm64-v8a
3. Start the emulator
4. Run: cargo apk run --release -p notedeck_chrome

🧪 Development

Android Configuration

Customize Android views for testing:

1. Copy example-android-config.json to android-config.json
2. Run make push-android-config to deploy to your device

Setting Up Developer Environment

./scripts/dev_setup.sh

This adds pre-commit hooks for proper code formatting.

📚 Documentation

Detailed developer documentation is available in each crate:

• Notedeck Core
• Notedeck Chrome
• Notedeck Columns
• Dave AI Assistant
• UI Components

🔄 Release Status

Notedeck is currently in BETA status. For the latest changes, see the CHANGELOG.

Future

Notedeck allows for app development built on top of the performant, built specifically for nostr database nostrdb. An example app written on notedeck is Dave

Building on notedeck dev documentation is also on the roadmap.

🤝 Contributing

Developers

Contributions are welcome! Please check the developer documentation and follow these guidelines:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Translators

Help us bring Notedeck to non-English speakers!

Request to join the Notedeck translations team through Crowdin.

If you do not have a Crowdin account, sign up for one. If you do not see your language, please request it in Crowdin.

🔒 Security

For security issues, please refer to our Security Policy.

📄 License

This project is licensed under the GPL - see license information in individual crates.

👥 Authors

• William Casarin jb55@jb55.com
• kernelkind kernelkind@gmail.com
• And contributors