Skip to content

cristyalmonte/learnnostr

Repository files navigation

LearnNostr

An interactive learning platform for the Nostr protocol built with MkDocs Material.

🌐 Live Site: learnnostr.org

Quick Start

# Clone and setup
git clone https://github.com/cristyalmonte/learnnostr.git
cd learnnostr

# Install dependencies
pip install -r requirements.txt

# Start development server
source venv/bin/activate  # if using virtual environment
mkdocs serve

Visit http://localhost:8000 to see the site locally.

What's Inside

  • Getting Started: Nostr basics, relay setup, essential tools
  • Core Concepts: Keys, relays, NIPs, fundamentals
  • Tutorials: Build real Nostr applications step-by-step
  • Interactive Features: Copy-paste code, syntax highlighting, responsive design

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Add content or improvements
  4. Test with mkdocs serve
  5. Submit a pull request

Tech Stack

  • MkDocs Material - Documentation framework
  • Python 3.8+ - Build system
  • Custom CSS/JS - Enhanced interactivity

License

MIT License - see LICENSE for details.


About

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages