|
| 1 | +# Keystache |
| 2 | + |
| 3 | +Keystache is a desktop Nostr key management and Bitcoin wallet. |
| 4 | + |
| 5 | +## Description |
| 6 | + |
| 7 | +Keystache is designed to provide a secure and user-friendly interface for managing Nostr keys and interacting with Fedimint Bitcoin federations. It offers features such as: |
| 8 | + |
| 9 | +- Nostr key management (creation, storage, and deletion) |
| 10 | +- Nostr relay management |
| 11 | +- Bitcoin wallet functionality through Fedimint federations |
| 12 | +- Secure, encrypted local storage of keys and data |
| 13 | + |
| 14 | +## Features |
| 15 | + |
| 16 | +- **Nostr Key Management**: Create, store, and manage Nostr keys securely. |
| 17 | +- **Relay Management**: Connect to and manage Nostr relays. |
| 18 | +- **Fedimint Bitcoin Wallet**: Send and receive Bitcoin through Fedimint federations. |
| 19 | +- **Encrypted Storage**: All sensitive data is encrypted at rest. |
| 20 | +- **User-Friendly Interface**: Built with Iced, a cross-platform GUI library for Rust. |
| 21 | + |
| 22 | +## Installation |
| 23 | + |
| 24 | +To build Keystache from source: |
| 25 | + |
| 26 | +1. Ensure you have Rust and Cargo installed on your system. |
| 27 | +2. Clone the repository: |
| 28 | + ``` |
| 29 | + git clone https://github.com/Open-Source-Justice-Foundation/Keystache.git |
| 30 | + ``` |
| 31 | +3. Navigate to the project directory: |
| 32 | + ``` |
| 33 | + cd Keystache |
| 34 | + ``` |
| 35 | +4. Build the project: |
| 36 | + ``` |
| 37 | + cargo build --release |
| 38 | + ``` |
| 39 | +5. Run the application: |
| 40 | + ``` |
| 41 | + cargo run --release |
| 42 | + ``` |
| 43 | + |
| 44 | +## Usage |
| 45 | + |
| 46 | +After launching Keystache, you'll be prompted to create a new password or enter an existing one to unlock your database. Once inside, you can: |
| 47 | + |
| 48 | +- Manage Nostr keys |
| 49 | +- Connect to and manage Nostr relays |
| 50 | +- Send and receive Bitcoin through Fedimint federations |
| 51 | +- Adjust settings and view application information |
| 52 | + |
| 53 | +## Development |
| 54 | + |
| 55 | +Keystache is built using Rust and the Iced GUI library. The project structure is as follows: |
| 56 | + |
| 57 | +- `src/`: Contains the main application code |
| 58 | +- `src/db/`: Database-related code |
| 59 | +- `src/fedimint/`: Fedimint integration |
| 60 | +- `src/nostr/`: Nostr-related functionality |
| 61 | +- `src/routes/`: Application routes and views |
| 62 | +- `src/ui_components/`: Reusable UI components |
| 63 | +- `assets/`: Contains icons and other static assets |
| 64 | + |
| 65 | +## Contributing |
| 66 | + |
| 67 | +Contributions to Keystache are welcome! Please feel free to submit pull requests, create issues, or suggest improvements. |
| 68 | + |
| 69 | +## License |
| 70 | + |
| 71 | +[Insert appropriate license information here] |
| 72 | + |
| 73 | +## Acknowledgments |
| 74 | + |
| 75 | +Keystache is created by Tommy Volk and generously funded by OpenSats. |
| 76 | + |
| 77 | +## Contact |
| 78 | + |
| 79 | +For questions or support, please [insert contact information or link to support resources]. |
0 commit comments