Official website for Shugur Relay - a production-ready Nostr relay built with Go and CockroachDB for enterprise-grade reliability and performance.
Production: https://shugur-network.github.io/Relay-Website/
Shugur Relay is a high-performance, distributed Nostr relay designed for production environments. It enables censorship-resistant social networks with high availability, automatic failover, and universal client compatibility.
- Enterprise-Ready: Built for production environments with advanced operational features
- Universal Compatibility: Works with all major Nostr clients through comprehensive protocol support
- Distributed Architecture: Multi-node relay cluster with real-time synchronization and automatic failover
- Enhanced Operations: Real-time monitoring, advanced logging, and intelligent configuration
- Quick Deployment: Enhanced installation scripts with interactive setup and error handling
- Framework: SvelteKit with TypeScript
- Styling: Tailwind CSS for responsive design
- Design System: @shugur/design-system for consistent UI components
- Icons: Lucide Svelte for beautiful iconography
- Fonts: League Spartan for Shugur branding
- Deployment: Netlify with automatic builds
- Static Generation: Pre-rendered for optimal performance
- Relay Architecture: Distributed multi-node cluster with high availability
The website showcases the latest Shugur Relay capabilities:
- Universal Client Compatibility: Comprehensive Nostr protocol support for all major clients
- Real-time Monitoring: Built-in metrics API with live performance dashboards
- Enhanced Event Processing: Advanced event dispatcher with optimized throughput
- Intelligent Configuration: Configurable content limits and smart resource management
- Advanced Logging: Comprehensive logging system with detailed insights
- Enhanced Installation: Interactive setup modes with error handling and health checks
- Main Documentation: docs.shugur.com
- Installation Guide: docs.shugur.com/installation
- Getting Started: docs.shugur.com/getting-started
- Architecture: docs.shugur.com/architecture
# Clone the repository
git clone https://github.com/Shugur-Network/Relay-Website.git
cd Relay-Website
# Install dependencies
npm install
# Start development server
npm run dev
# Open http://localhost:5173 in your browser# Development
npm run dev # Start dev server with hot reload
npm run dev -- --host # Expose dev server to network
# Building
npm run build # Build for production
npm run preview # Preview production build locally
# Code Quality
npm run check # Run Svelte type checking
npm run check:watch # Watch mode for type checking
npm run lint # Run ESLint
npm run format # Format code with Prettiersrc/
├── routes/ # SvelteKit routes
│ ├── +layout.svelte # Global layout with navigation
│ ├── +layout.ts # Layout configuration (prerender)
│ ├── +page.svelte # Homepage
│ └── about-nostr/
│ └── +page.svelte # About Nostr detailed page
├── lib/
│ └── components/ # Website-specific components
│ ├── Navigation.svelte # Header with logo and navigation
│ ├── VersionBanner.svelte # Dismissible version announcements
│ ├── Hero.svelte # Landing hero section
│ ├── Features.svelte # Key features showcase
│ ├── Installation.svelte # Enhanced installation instructions
│ ├── Architecture.svelte # Technical overview
│ └── Footer.svelte # Site footer
├── app.html # HTML template with fonts
├── app.css # Global styles and logo CSS
└── ...
static/
├── favicon.ico # Site favicon
└── shugur-logo.svg # Shugur brand logo
Note: The website focuses on business benefits and user value, with detailed technical documentation available at docs.shugur.com.
The Shugur Design System has been moved to its own dedicated repository for better reusability and maintenance:
Repository: Shugur-Network/design-system
npm install @shugur/design-systemimport { Button, Card, Navigation, Hero, Features, Footer } from '@shugur/design-system';- 6 Core Components: Button, Card, Navigation, Hero, Features, Footer
- Complete Design Tokens: Colors, typography, spacing, animations
- Accessibility: WCAG 2.1 AA compliant
- Responsive Design: Mobile-first approach
- TypeScript Support: Full type definitions included
For detailed documentation, examples, and usage guides, visit the design system repository.
- Platform: Netlify
- Trigger: Push to
mainbranch - Build Command:
npm run build - Publish Directory:
build - Base Path:
/Relay-Website/(configured for subdirectory deployment)
The site is configured for deployment to a subdirectory path:
- Production Base:
/Relay-Website/ - Assets Path: Configured for proper static asset resolution
- Prerendering: Enabled for optimal SEO and performance
# Build the site
npm run build
# The 'build' directory contains the static site
# Upload to any static hosting providerSupported Platforms:
- ✅ Netlify (current)
- ✅ Vercel
- ✅ GitHub Pages
- ✅ Cloudflare Pages
- ✅ Any static hosting provider
- Design System: Shugur-Network/design-system
- Main Relay Repository: Shugur-Network/Relay
- Company Website: shugur.com
- Documentation Site: docs.shugur.com
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Make your changes
- Test locally:
npm run dev - Build to verify:
npm run build - Commit your changes:
git commit -m 'Add amazing feature' - Push to the branch:
git push origin feature/amazing-feature - Submit a pull request
- Use TypeScript for type safety
- Follow existing component patterns
- Use @shugur/design-system components when possible
- Ensure responsive design (mobile-first)
- Test on multiple screen sizes
- Maintain consistent branding
This project is part of the Shugur Network ecosystem. See the main Relay repository for license information.
- Issues: GitHub Issues
- Documentation: docs.shugur.com
- Main Project: Shugur-Network/Relay
Built with ❤️ by Shugur team for the decentralized web.