https://github.com/skorotkiewicz/nostrwykop
Decentralized social platform built on the Nostr protocol
https://github.com/skorotkiewicz/nostrwykop
decentralized nostr react social
Last synced: about 2 months ago
JSON representation
Decentralized social platform built on the Nostr protocol
- Host: GitHub
- URL: https://github.com/skorotkiewicz/nostrwykop
- Owner: skorotkiewicz
- License: mit
- Created: 2025-04-10T19:11:07.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-10T19:38:18.000Z (2 months ago)
- Last Synced: 2025-04-10T20:39:17.604Z (2 months ago)
- Topics: decentralized, nostr, react, social
- Language: JavaScript
- Homepage:
- Size: 250 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NostrWykop
A modern, decentralized social platform built on the [Nostr protocol](https://nostr.com/). NostrWykop combines the functionality of community-driven content aggregation with the censorship-resistant nature of the Nostr network.
## 🌟 Features
- **Decentralized Content Platform**: Built on Nostr protocol for censorship resistance
- **Multilingual Support**: Available in English and Polish
- **Rich Content Sharing**: Post and discover articles, links, and media
- **Community Interaction**: Comment, reply, and vote on posts
- **User Profiles**: Follow other users and build your network
- **Content Discovery**: Search for posts, filter by tags, and discover trending content
- **Customizable Feeds**: View posts from followed users or explore specific tags
- **Responsive Design**: Works seamlessly on desktop and mobile devices
- **Dark/Light Mode**: Switch between themes for optimal viewing experience
## 🚀 Getting Started
### Prerequisites
- Node.js (v18.0.0 or higher)
- npm or yarn
- A Nostr-compatible browser extension (e.g., [nos2x](https://github.com/fiatjaf/nos2x), [Alby](https://getalby.com/), or [Flamingo](https://www.getflamingo.org/)) (optional)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/skorotkiewicz/NostrWykop.git
cd NostrWykop
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
3. Start the development server:
```bash
npm run dev
# or
yarn dev
```
4. Open your browser and navigate to `http://localhost:3000`
### Building for Production
```bash
npm run build
# or
yarn build
```
## 🛠️ Technology Stack
- **Frontend Framework**: React 19
- **Routing**: React Router v7
- **Internationalization**: i18next
- **Build Tool**: Vite
- **Networking**: Nostr-tools for Nostr protocol integration
- **Linting**: Biome
## 🔌 Nostr Integration
NostrWykop connects to multiple Nostr relays to provide a robust and decentralized experience:
- wss://relay.damus.io
- wss://nos.lol
## 🗺️ Roadmap
- [ ] Enhanced media embedding
- [x] Direct messaging between users
- [x] Custom themes and dark mode
- [ ] Mobile application
- [ ] Integration with additional Nostr clients
- [ ] Community moderation tools
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## 📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
## 📞 Contact
Project Link: [https://github.com/skorotkiewicz/NostrWykop](https://github.com/skorotkiewicz/NostrWykop)
---
Built with ❤️ by [skorotkiewicz](https://github.com/skorotkiewicz)