.. _orb-web-serve:

orb web serve
=============

Usage:
-----

.. code::

   $ orb web serve   [OPTIONS]


Options:
---------

* --host TEXT: The allowed host.  [default: 0.0.0.0]
* --port INTEGER: The port to serve.  [default: 8080]
* --reload / --no-reload: Live reloading (dev).  [default: False]
* --debug / --no-debug: Show debug info (dev).  [default: False]
* --workers INTEGER: Number of web workers.  [default: 1]
* --help: Show this message and exit.

Description:
-----------

Creates a web application with `FastAPi <https://fastapi.tiangolo.com/>`_
in the backend and `Svelte <https://svelte.dev>`_ in the frontend.

Refer to :ref:`web` to find out about building your own
CLN / LND web-app using Orb in the backend.

.. asciinema:: /_static/orb-web-serve.cast