docs: update README with correct domain, new features, and current custom kinds

Co-authored-by: shakespeare.diy <assistant@shakespeare.diy>
This commit is contained in:
shakespeare.diy 2026-06-16 11:24:09 +07:00
parent 9fc39651ca
commit f2efac72d9

View file

@ -1,27 +1,30 @@
# SkateSpots - Decentralized Skate Map & Community # SkateSpots - Decentralized Skate Map & Community
[![Edit with Shakespeare](https://shakespeare.diy/badge.svg)](https://shakespeare.diy/clone?url=nostr%3A%2F%2Fnpub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx%2Fgit.shakespeare.diy%2Fskate-spots) [![Edit with Shakespeare](https://shakespeare.diy/badge.svg)](https://shakespeare.diy/clone?url=nostr%3A%2F%2Fnpub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx%2Fgit.shakespeare.diy%2FSkateSpots)
A decentralized skateboarding community platform built on Nostr. Discover skate spots, find coaches, join events, and connect with skaters worldwide. A decentralized skateboarding community platform built on Nostr. Discover skate spots, find coaches, join events, and connect with skaters worldwide.
## 🌐 Live App ## 🌐 Live App
- **Deployed URL**: https://skate-spots.com - **Deployed URL**: https://skate-spots.org
- **Previous URL**: https://skate-spots.shakespeare.wtf (redirects to new domain) - **Nostr Git**: nostr://npub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx/git.shakespeare.diy/SkateSpots
- **Nostr Git**: nostr://npub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx/git.shakespeare.diy/skate-spots
## ✨ Features ## ✨ Features
- 🗺️ **Interactive Skate Map** - Discover skate spots worldwide with geolocation - 🗺️ **Interactive Skate Map** - Discover skate spots worldwide with geolocation
- 🛹 **Spot Database** - Browse, create, and review skate parks and street spots - 🛹 **Spot Database** - Browse, create, and review skate parks and street spots
- 📅 **Events Calendar** - Find and create skateboarding events and competitions - 📅 **Events Calendar** - Find and create skateboarding events and competitions
- 👨‍🏫 **Find Coaches** - Connect with skateboarding instructors in your area - 👨‍🏫 **The Lab** - Connect with coaches, filmers, and video editors in your area
- 🎬 **Video Editors** - Find editors who list their software, hardware, and portfolio
- 🛍️ **Skate Shops** - Discover local skate shops and support the community - 🛍️ **Skate Shops** - Discover local skate shops and support the community
- 🔄 **Buy/Sell Gear** - Marketplace for used skate gear (NIP-99 classified listings)
- 🎒 **My Stash** - Private encrypted gear inventory with location tracking
- 🎵 **NoGood Radio** - 24/7 vibing music (lofi, synthwave, electronica) - 🎵 **NoGood Radio** - 24/7 vibing music (lofi, synthwave, electronica)
- ⚡ **Lightning Zaps** - Send Bitcoin tips to content creators - ⚡ **Lightning Zaps** - Send Bitcoin tips to content creators
- 🌤️ **Weather Integration** - Check conditions before you skate - 🌤️ **Weather Integration** - Check conditions before you skate
- 🔐 **Nostr Authentication** - Decentralized login with your Nostr keys - 🔐 **Nostr Authentication** - Decentralized login with your Nostr keys
- 📱 **PWA Support** - Install as a native app on any device - 📱 **PWA Support** - Install as a native app on any device
- ❤️ **Supporters** - Community funding via Geyser (Bitcoin Lightning)
## 🛠️ Technology Stack ## 🛠️ Technology Stack
@ -46,7 +49,7 @@ A decentralized skateboarding community platform built on Nostr. Discover skate
```bash ```bash
# Clone the repository # Clone the repository
git clone nostr://npub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx/git.shakespeare.diy/skate-spots git clone nostr://npub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx/git.shakespeare.diy/SkateSpots
# Install dependencies # Install dependencies
npm install npm install
@ -93,11 +96,16 @@ SkateSpots works as a Progressive Web App (PWA) and can be installed on:
This app uses custom Nostr event kinds defined in `NIP.md`: This app uses custom Nostr event kinds defined in `NIP.md`:
- **Kind 30818** - Skate Spots (addressable) | Kind | Type | Description |
- **Kind 30819** - Skate Events (addressable) |------|------|-------------|
- **Kind 30820** - Skate Coaches (addressable) | 30017 | Addressable | Skate Shops (NIP-15 Stall) |
- **Kind 30821** - Skate Shops (addressable) | 30402 | Addressable | Gear Listings (NIP-99 Classified) |
- **Kind 30822** - Food Spots (addressable) | 30818 | Addressable | Skate Spots |
| 30823 | Addressable | Skate Tours |
| 31923 | Addressable | Skate Events (NIP-52 Calendar) |
| 35001 | Addressable | Skate Coaches |
| 35002 | Addressable | Skate Filmers / Photographers |
| 35003 | Addressable | Skate Video Editors |
### Relay Configuration ### Relay Configuration
@ -105,6 +113,24 @@ Default relay: `wss://goskatespots.nostr1.com`
Users can manage relays in Settings following NIP-65. Users can manage relays in Settings following NIP-65.
## 🎒 My Stash
The Stash is a private, encrypted gear inventory (NIP-51 kind 30001). Users can track their equipment with:
- **Categories**: Decks, trucks, wheels, bearings, shoes, apparel, protective gear, and more
- **Storage locations**: Home, car, backpack, wardrobe, van, skatepark, friend's, parents', warehouse, storage unit, sponsor, or other
- **Condition rating** (1–5 stars), rarity tier, and optional price
- **Visibility control**: Private (encrypted), friends-only, or public
- **Filter & search** by category, storage location, or keyword
## 🧪 The Lab
The Lab connects skaters with service providers in three categories:
- **Coaches** - Skateboarding instructors with skill specializations
- **Filmers** - Videographers and photographers with equipment/style details
- **Video Editors** - Editors who list their software (Premiere, DaVinci, After Effects, etc.), hardware setup, portfolio, and contact details
## 📦 Dependencies Overview ## 📦 Dependencies Overview
### Core Dependencies ### Core Dependencies
@ -129,7 +155,6 @@ Users can manage relays in Settings following NIP-65.
### Bitcoin & Lightning ### Bitcoin & Lightning
- `@getalby/sdk` - Alby wallet integration - `@getalby/sdk` - Alby wallet integration
- `@cashu/cashu-ts` - Cashu ecash protocol - `@cashu/cashu-ts` - Cashu ecash protocol
- `coco-cashu-*` - Cashu wallet implementation
- `npubcash-sdk` - npub.cash integration - `npubcash-sdk` - npub.cash integration
- `bitcoinjs-lib` - Bitcoin utilities - `bitcoinjs-lib` - Bitcoin utilities
- `@noble/curves` & `@noble/hashes` - Cryptography - `@noble/curves` & `@noble/hashes` - Cryptography
@ -194,19 +219,34 @@ This is a Nostr-based open source project. Contributions are welcome!
## 📄 License ## 📄 License
MIT License - See LICENSE file for details **YOU ARE FREE TO SKATEBOARD**
This project is open. Share it, fork it, build on it, skate it. The streets belong to everyone. So does this code. Just keep skating and don't be a kook.
Copyright © 2025–∞ SkateSpots contributors & the community
See `/license` in the app for the full license page.
## ❤️ Support the Project
SkateSpots is 100% free, open-source, and community-funded. No ads, no data selling, no investors.
- **Geyser**: https://geyser.fund/project/skatespots
- **Supporters page**: https://skate-spots.org/supporters
## 🙏 Credits ## 🙏 Credits
- **Built with**: [MKStack](https://soapbox.pub/mkstack) - Nostr client framework - **Built with**: [MKStack](https://soapbox.pub/mkstack) - Nostr client framework
- **Vibed with**: [Shakespeare](https://shakespeare.diy) - AI-powered development - **Vibed with**: [Shakespeare](https://shakespeare.diy) - AI-powered development
- **Powered by**: [Nostr](https://nostr.com) - Decentralized protocol - **Powered by**: [Nostr](https://nostr.com) - Decentralized protocol
- **Funded by**: [Geyser](https://geyser.fund/project/skatespots) - Bitcoin Lightning crowdfunding
## 🔗 Links ## 🔗 Links
- [Live App](https://skate-spots.com) - [Live App](https://skate-spots.org)
- [Nostr Git Repository](nostr://npub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx/git.shakespeare.diy/skate-spots) - [Supporters](https://skate-spots.org/supporters)
- [Edit with Shakespeare](https://shakespeare.diy/clone?url=nostr%3A%2F%2Fnpub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx%2Fgit.shakespeare.diy%2Fskate-spots) - [Nostr Git Repository](nostr://npub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx/git.shakespeare.diy/SkateSpots)
- [Edit with Shakespeare](https://shakespeare.diy/clone?url=nostr%3A%2F%2Fnpub1yrnuj56rnen08zp2h9h7p74ghgjx6ma39spmpj6w9hzxywutevsst7k5cx%2Fgit.shakespeare.diy%2FSkateSpots)
## 📞 Support ## 📞 Support
@ -217,4 +257,3 @@ For issues or questions:
--- ---
Made with ❤️ for the skateboarding community Made with ❤️ for the skateboarding community