Skip to content

lumehq/coop

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CoopDemo

Actions GitHub repo size GitHub issues GitHub pull requests

Coop is a cross-platform Nostr client designed for secure communication focus on simplicity and customizability.

New✨: A blog post introducing Coop in details has been posted here.

Coop is currently in the alpha stage of development. This means the app may contain bugs, incomplete features, or unexpected behavior. We recommend using it for testing purposes only and not for critical or sensitive communications. Your feedback is invaluable in helping us improve Coop, so please report any issues or suggestions via the GitHub Issue Tracker. Thank you for your understanding and support!

Installation

To install Coop, follow these steps:

  1. Download the Latest Release:

  2. Install:

    • Windows: Run the downloaded .exe installer and follow the on-screen instructions.
    • macOS: Open the downloaded .dmg file and drag Coop to your Applications folder.
    • Ubuntu: Run the downloaded .deb or .AppImage installer and follow the on-screen instructions.
    • Arch Linux: For .tar.gz packages, extract and install manually. For PKGBUILD, use makepkg -si to build and install.
    • Flatpak: Coming soon.
  3. Run Coop:

    • Launch Coop from your Applications folder (macOS) or by double-clicking the executable (Windows/Linux).

For more detailed instructions, refer to the Release Notes on GitHub.

Developing Coop

Coop is built using Rust and GPUI. All Nostr related stuffs handled by Rust Nostr SDK

Prerequisites

  • Rust Toolchain: Ensure you have Rust installed. If not, you can install it using rustup.
  • Cargo: Rust's package manager, which comes bundled with the Rust installation.
  • Git: To clone the repository and manage version control.

Setting Up the Development Environment

  1. Clone the repository:

    git clone https://github.com/lumehq/coop.git
    cd coop
  2. Install dependencies:

    cargo build
  3. Run the app:

    cargo run

Building for Production

To build Coop for production, use the following command:

cargo build --release

This will generate an optimized binary in the target/release directory.

Contributing Code

If you'd like to contribute to Coop, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes and ensure all tests pass.
  4. Submit a pull request with a detailed description of your changes.

For more information, see the Contributing section.

Debugging

To debug Coop, you can use cargo's built-in debugging tools or attach a debugger like gdb or lldb. For example:

cargo run -- --debug

Additional Resources

License

Copyright (C) 2025 Ren Amamiya & other Coop contributors

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.