nice-vibes 0.1.0

Developing beautiful NiceGUI applications with AI

Nice Vibes - Teach AI agents to build beautiful NiceGUI applications

A comprehensive toolkit of prompts, patterns, and examples that help AI coding assistants generate correct, idiomatic NiceGUI code.

✨ Features

• 📚 Complete Documentation - Events, mechanics, styling, and class references
• 🔐 Authentication Patterns - Signed cookie persistence, role-based permissions, login flows
• 🧭 SPA Navigation - ui.sub_pages, header/drawer visibility, back button handling
• 🧪 Working Samples - Full multi-dashboard app, stock analysis, custom components
• 🤖 AI-Optimized - Single master prompt (~22K tokens) for context injection
• ✅ Validated - All class references and URLs verified
• 🧩 Modular - Pick what you need or use the full prompt

🚀 Quick Start

Use Pre-Built Prompts (Recommended)

Just download and use the pre-built master prompt directly:

Variant	Tokens	Use Case	Download
Compact	~14K	Quick tasks, simple UI	nice_vibes_compact.md
Optimum	~23K	Most use cases	nice_vibes.md
Extended	~34K	Custom components, deployment	nice_vibes_extended.md

Copy the content into your AI assistant's context or system prompt.

Build From Source (Optional)

Only needed if you want to customize or extend the documentation:

git clone https://github.com/Alyxion/nice-vibes.git
cd nice-vibes
poetry install
poetry run python scripts/build_master_prompt.py

📋 Requirements

For building from source:

• Python 3.12+
• Poetry

📖 Documentation

Folder	Description
docs/	Main documentation
docs/events/	Event handling patterns
docs/mechanics/	Core patterns (SPA, authentication, styling)
docs/classes/	UI element reference by category

📂 Other Folders

Folder	Description
samples/	Working example applications
output/	Generated master prompts
scripts/	Build and validation tools
tests/	Example NiceGUI tests

🧪 Testing

poetry run pytest -v

🤖 Prompt Variants

Each variant is available in online (GitHub URLs) and offline (local paths) versions:

Content	Compact	Optimum	Extended
Main guide	✓	✓	✓
Core mechanics	✓	✓	✓
Events	ref	✓	✓
Class reference	ref	✓	✓
Custom components	ref	ref	✓
Configuration & deployment	ref	ref	✓
Sample references	✓	✓	✓

ref = Not included but referenced with summary (AI knows where to look)

Configure file order and summaries in docs/prompt_config.yaml.

✅ Validation

# Validate class references
poetry run python scripts/validate_classes.py

# Also check URLs
poetry run python scripts/validate_classes.py --check-urls

🙏 Credits

Created by Michael Ikemann

Built for use with NiceGUI - a Python UI framework by Zauberzeug.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Free to use, modify, and distribute.