Welcome

This is our place to host additional content which can be easily edited by the community. Check out the FAQs and our official documentation with hundreds of live examples at https://nicegui.io.

Community Projects

Extensions and Libraries

• RoSys: an easy-to-use robot system with a similar purpose as ROS/ROS2 from the NiceGUI maintainers
• Tabulator: Great package to create tables using the Tabulator library.
• ex4nicegui: An extension library with built-in responsive components and data-responsive interface programming.
• CatDesign: a comprehensive design system offering a set of pre-styled components and features that are readily usable
• OpenLLM: Chat with various LLM Models
• NiceGUI WebSerial: Uses JavaScript webserial API to control NeoPixel LEDs at the client with Python code running on a server.
• FIEF Web App Demo using NiceGUI: Uses Traefik, FastAPI, FIEF, PostgreSQL, Redis, HTML, NiceGUI, Bash Scripts, Docker-Compose
• NiceGUI CRUD-Component: User interface for your python object lists, Create, Update and Delete items, configure automatically from pydantic BaseModel settings
• NiceDeck: Create slideshows in Python using NiceGUI
• NiceGUI Template: Makes it easy for beginners or advanced developers to start off a modular project structure.

Examples

• LLM Chat Example: Microsoft demos their Node Engine with a NiceGUI driven GUI to interact with OpenAI models.
• Discord Oauth with NiceGUI and Zenora: A simple integration of Discord Oauth to login and logout using NiceGUI and Zenora's Discord API Wraper.
• LangChain UI: Adaptation of the chat example to work with an AI large language model
• Azure Deployment: example that shows one method of deploying a NiceGUI container in Azure Container Apps (ACA) using GitHub Actions
• Speakscribe: a web app that lets you transcribe audio using OpenAI and chat with a bot
• GPT-NiceGUI: uses GPT LLM from OpenAI in combination with a knowledge database to answer NiceGUI questions and write code
• Zauberzeug Website: the robotics and software company which maintains NiceGUI also uses it to run their website
• ROS2 image display: using NiceGUI to display images received via ROS2 topics as a lean alternative to RViz
• ROS2 turtlesim joystick: using NiceGUI's joystick to control turtlesim
• FullCalendar with Plugins: Example on how to use the FullCalendar library with plugins.

Applications

• Card Index: It's like IMDb but for credit cards.
• Pinger: simple network utility
• Hush: a Docker based fan controller
• RoutineButler: administer user-set routines and leverages the lockbox to motivate the user to complete them with a kiosk mode on Raspberry Pi
• Nanoleaf Control: control Nanoleaf lights and create effects in a more convenient way
• Synth Mapping Helper: helpful tools to assist in making Synth Riders maps
• ODrive GUI: web-based GUI to tweak and debug the ODrive motor controller
• Broh5: (Bro)wser-based GUI (H)DF(5) Viewer, implemented with Model-View-Controller pattern and a monolitic version as comparision
• Slaanesh: a game tracker, allowing for keeping track of games played as well as maintaining a wishlist and backlog
• Monoquant: A no-code trading strategy editor with backtesting, AI and much more.
• Beaver Habits Tracker: A self-hosted habit tracking app without "Goals".
• Sonos Moments: A simple web app to control Sonos speakers.

Tutorials

Videos

• Build an image gallery with good explanation of all steps needed by "Python for Everyone".
• Build a Daily Planner by Nylas.

Wiki

• Search as You Type: Build the cocktail recipes example step-by-step.
• Deploy on fly.io: Get your web app onto a public server hosted by fly.io.
• Deploy in Google Cloud Run: Install your web app on a server hosted by Google.
• ROS2 turtlesim joystick: How ROS2 works with NiceGUI for the turtlesim tutorial.
• ROS2 image receiver: How ROS2 works with NiceGUI based on the ROS2 image display example.

Postings

• NiceGUI: How to create stunning web interfaces in Python with minimal code
• Tutorial on deployment at Hetzner Online GmbH

ChatGPT and other LLMs

As discussed in #1371 NiceGUI is not (yet) well known by ChatGPT and other LLMs. This is unfortunate because it often starts hallucinating instead of admitting its ignorance. We can simply use this prompt text which can be copy-and-pasted into ChatGPT at the start of a conversation. This will provide ChatGPT with the basic concepts of NiceGUI. If you really want the LLM to understand NiceGUI, we provide the full documentation in JSON format at https://nicegui.io/static/sitewide_index.json.

You can also use a short text as part of your custom instructions.