mkstack/README.md

79 lines
3.0 KiB
Markdown
Raw Normal View History

2025-07-14 21:40:30 +00:00
# 🍄 Gnome Nostr - The Sacred Network of Woodland Folk
2025-07-14 21:40:30 +00:00
A magical Nostr client where all text notes (kind 1 events) are automatically translated into the ancient gnome tongue! Connect with fellow earth-dwellers across the message-mushroom network.
## ✨ Features
- **🍄 Gnome Speak Translation**: All kind 1 events are automatically translated into whimsical gnome language
- **🌲 Forest-Themed UI**: Beautiful gnome-inspired design with earthy colors and woodland aesthetics
- **🔗 Full Nostr Compatibility**: Works with any Nostr relay and preserves all protocol functionality
- **📱 Responsive Design**: Works perfectly on desktop and mobile devices
- **🌙 Dark/Light Mode**: Toggle between day forest and night forest themes
- **⚡ Lightning Fast**: Built with modern React, Vite, and TailwindCSS
## 🎭 Gnome Speak Examples
Regular text is magically transformed:
- `"Hello world!"``"Greetings, fellow earth-dweller world! By my pointy hat!"`
- `"Good morning everyone"``"🌅When dew kisses the earth🌅 all forest folk"`
- `"I love bitcoin"``"I cherish like precious gems ✨golden acorns of the digital realm✨"`
- `"This is about #nostr"``"This is a woodland proclamation about #nostr"` (hashtags preserved)
## 🛡️ Protocol Preservation
While the display is transformed into gnome speak, the underlying Nostr protocol remains unchanged:
- ✅ URLs are preserved and linkified
- ✅ Nostr references (npub, note, etc.) work normally
- ✅ Hashtags remain functional for filtering
- ✅ Original content is preserved for replies and quotes
- ✅ Compatible with all other Nostr clients
## 🏗️ Technical Details
- **Framework**: React 18 with TypeScript
- **Styling**: TailwindCSS with custom gnome theme
- **Nostr**: Nostrify for protocol integration
- **Font**: Comfortaa Variable for whimsical feel
- **Build**: Vite for fast development and production builds
## 🌟 Custom NIP
This client implements a custom translation protocol documented in `NIP.md`. The translation:
- Only affects kind 1 events (Short Text Notes)
- Preserves URLs, Nostr references, and hashtags
- Maintains semantic meaning while adding magical charm
- Is purely client-side - no protocol changes required
## 🚀 Getting Started
1. **Clone the repository**
2. **Install dependencies**: `npm install`
3. **Start development**: `npm run dev`
4. **Build for production**: `npm run build`
## 🎨 Customization
The gnome vocabulary can be extended in `src/lib/gnomeSpeak.ts`. Add new word mappings to enhance the magical transformation!
## 🤝 Contributing
Contributions are welcome! Whether you want to:
- Add more gnome vocabulary
- Improve the forest-themed UI
- Fix bugs or add features
- Enhance the translation algorithm
Feel free to open issues and pull requests.
## 📜 License
This project is open source and available under the MIT License.
---
*Vibed with [MKStack](https://soapbox.pub/mkstack) • Blessed by the forest spirits 🍄✨*
**May your mushrooms grow tall and your acorns be golden!** 🌰✨