Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mnpezz/xnostr
Nostr feed for nano currency users.
https://github.com/mnpezz/xnostr
nanocurrency nostr nostr-client
Last synced: 3 days ago
JSON representation
Nostr feed for nano currency users.
- Host: GitHub
- URL: https://github.com/mnpezz/xnostr
- Owner: Mnpezz
- Created: 2024-11-02T14:43:33.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T14:16:34.000Z (2 months ago)
- Last Synced: 2024-11-11T09:41:39.773Z (2 months ago)
- Topics: nanocurrency, nostr, nostr-client
- Language: JavaScript
- Homepage:
- Size: 455 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# xnostr - Nano-Focused Nostr Client
A specialized Nostr client focused on the Nano cryptocurrency community. xnostr allows users to view posts from Nostr users who have Nano addresses in their profiles, send Nano tips, and interact with Lightning Network through Zaps.
Live at https://mnpezz.github.io/xnostr/
## Features
### Core Features
- **Specialized Nano Feed**:
- Automatically detects and displays posts from users with Nano addresses
- Real-time feed updates
- Smart filtering of Nano-related content
- **Dual Feed System**:
- Nano Feed: Focused view of Nano-related posts
- General Feed: Standard Nostr timeline
- **User Interface**:
- Dark mode support
- Mobile-responsive design
- Character counter for posts
- Infinite scroll loading
- Back to top button
### Payment Integration
- **Nano Tips**:
- Direct Nano tipping through nano.to
- Automatic Nano address detection
- Seamless payment experience
- **Lightning Network**:
- Zap support through Alby
- Lightning address integration
- Quick tipping functionality
### User Experience
- **Profile Management**:
- Easy Nano address integration
- Lightning address setup
- Profile customization options
- Quick copy buttons for addresses
- **Interactive Features**:
- Threaded conversations
- Reply support
- Post likes and boosts
- Share functionality
- Real-time notifications
### Technical Features
- **Multiple Login Options**:
- Alby extension support
- nsec private key login
- Secure authentication
- **Relay Management**:
- Custom relay configuration
- Automatic relay discovery
- Connection status monitoring
## Getting Started
### Local Development Setup
1. Clone the repository:
```bash
git clone https://github.com/yourusername/xnostr.git
cd xnostr
```
2. Serve the files locally:
- Using Python:
```bash
python -m http.server 8000
```
- Using Node.js:
```bash
npx http-server
```
- Using PHP:
```bash
php -S localhost:8000
```
3. Open `http://localhost:8000` in your browser
### For New Users
1. Choose your login method:
- **Desktop (Recommended)**: Install [Alby Extension](https://getalby.com)
- **Mobile or No Extension**: Use NSEC key login
- Click "Generate New nsec" for a new account
- Save the generated key securely
- Use the visibility toggle to verify key
- Login with your saved key
2. Enable Dark Mode (Optional):
- Click the Settings tab
- Find the Dark Mode toggle
- Click to switch between light and dark themes
- Your preference will be saved automatically
### For Existing Nostr Users
1. **Connect to xnostr**:
- Desktop: Use Alby extension
- Mobile: Login with nsec key
2. **Add Your Nano Address**:
- Go to Profile tab
- Add your Nano address
- Save changes
3. **Start Interacting**:
- View Nano-related posts
- Send tips
- Engage with the community
## Usage Tips
### Profile Management
- Your npub and public key are displayed in the Profile tab
- Use the copy buttons for quick sharing
- Add your Nano address in the format: `nano_address` or with prefix `Nano: nano_address`
### Post Creation
- Character limit: 280 characters
- Character counter shows remaining space
- Support for image URLs (automatically embedded)
- Reply to posts by clicking the reply button
### Navigation
- Use the Back to Top button for quick navigation
- Infinite scroll loads more posts automatically
- Switch between Nano and General feeds using tabs
### Dark Mode
- Toggle in Settings tab
- Automatically saves preference
- Improves readability in low-light conditions
### Post Interaction
- Click the reply button (💬) to open the reply form
- Type your reply in the text area
- Click "Send Reply" to post your response
- Replies are shown threaded under the original post
- Reply counts show the number of responses
- Replies are loaded dynamically when viewing a thread
## Prerequisites
- Modern web browser
- For desktop:
- [Alby Extension](https://getalby.com/) for Lightning Network
- For mobile:
- Your nsec key
- Nano wallet for sending tips
## Technical Details
### Architecture
- Built with vanilla JavaScript
- No build process required
- Modular design with separate concerns:
- `app.js`: Main application logic
- `nostr-client.js`: Nostr protocol handling
- `utils.js`: Utility functions
- `styles.css`: All styling
### Implementation Details
- Uses nostr-tools library
- Implements:
- NIP-01 (Basic Protocol Flow)
- NIP-57 (Lightning Zaps)
- Custom Nano tipping integration
- Local storage for preferences
- Real-time updates via WebSocket
## Security Considerations
- Never shares or stores private keys
- Client-side only operation
- Secure connection handling
- Private key input protection
- No external dependencies beyond essential libraries
## Contributing
1. Fork the repository
2. Create your feature branch: `git checkout -b feature/AmazingFeature`
3. Commit your changes: `git commit -m 'Add some AmazingFeature'`
4. Push to the branch: `git push origin feature/AmazingFeature`
5. Open a Pull Request
### Development Guidelines
- Maintain vanilla JavaScript approach
- Follow existing code style
- Add comments for complex logic
- Update README for new features
- Test on both desktop and mobile
- Test both light and dark modes
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Acknowledgments
- [Nostr Protocol](https://github.com/nostr-protocol/nips)
- [nano.to](https://nano.to) for Nano payments
- [Alby](https://getalby.com) for Lightning Network integration
- [iris.to](https://iris.to) for Nostr onboarding
## Support
For support:
- Open an issue on GitHub
- Join the Nostr community
- Follow development updates on Nostr
## Troubleshooting
Common issues and solutions:
1. **Connection Issues**:
- Check relay connections in Settings
- Try adding additional relays
- Verify internet connection
2. **Login Problems**:
- Ensure Alby is properly installed
- Verify nsec format
- Clear browser cache
3. **Display Issues**:
- Try toggling dark mode
- Refresh the page
- Clear browser cache
### NSEC Key Management
- **Generating New Key**:
- Use the "Generate New nsec" button
- Copy key from the popup immediately
- Store key securely before logging in
- Use visibility toggle to verify copied key correctly
- **Key Visibility**:
- Toggle eye icon to show/hide key
- Verify key format starts with "nsec1"
- Copy key before closing generator popup