💜 Nostr.how

A comprehensive guide to all things Nostr. Including step-by-step setup guides and details on clients, relays, and NIPs.

Tech Stack

• Framework: SvelteKit with Svelte 5
• Styling: Tailwind CSS v4
• Content: Markdown via mdsvex
• i18n: svelte-i18n
• Linting: Biome
• Package Manager: Bun
• Hosting: Vercel

Getting Started

1. Clone this repo
2. Install dependencies: bun install
3. Run the dev server: bun dev
4. Open http://localhost:5173

Available Commands

Command	Description
bun dev	Start development server
bun run build	Build for production
bun run preview	Preview production build
bun run check	Run TypeScript/Svelte type checking
bun run lint-check	Check code with Biome
bun run lint-write	Fix lint issues with Biome
bun run format-write	Format code with Biome

Contributing

We're always looking for writers, coders, and translators to help us make Nostr.how more useful. If you have an idea on how to make the site better, please let me know.

Create or Edit Content

If you recently learned something new about Nostr, it's likely that other people don't know it yet! Feel free to write in whatever format you'd like and then reach out on Nostr and I'll get the page into the codebase. Or, if you're technical, feel free to create a PR directly.

If you're less of a writer but have a sharp eye for typos and grammar, feel free to create issues here on GitHub.

Translations

Translations have two parts:

1. UI strings: JSON files in /src/lib/locales/ (e.g., en.json, es.json)
2. Content pages: Markdown files in /src/routes/pages/{lang}/

Quick Start for Translators

1. Fork this repository
2. Create a branch: git checkout -b <language>_translation
3. For UI strings: Copy en.json and translate the values (not keys)
4. For content: Create a folder with your language's ISO 639-1 code and translate each .md file
5. Submit a Pull Request

Content Translation Tips

• Keep frontmatter format intact (the --- section at the top)
• Translate the title and description values
• Update internal links to use your language code (e.g., /en/get-started → /fr/get-started)
• Anchor links can be translated (e.g., #understanding-keys → #comprendre-les-cles)

Project Structure

src/
├── lib/
│   ├── components/    # Svelte components
│   ├── locales/       # i18n JSON files
│   └── config/        # Configuration
└── routes/
    ├── pages/         # Markdown content by language
    │   ├── en/
    │   ├── es/
    │   ├── de/
    │   └── ...
    └── [locale=locale]/  # Localized routing

License

MIT License - see LICENSE