Installation
============

Requirements
------------

BadGUI requires:

- Python 3.8 or higher
- Node.js 16+ (for running generated Vue.js projects)
- npm or yarn (for package management)

Install BadGUI
--------------

Install from PyPI using pip::

    pip install badgui

Development Installation
------------------------

To install BadGUI for development::

    git clone https://github.com/your-username/badgui.git
    cd badgui
    pip install -e .

Verify Installation
-------------------

To verify that BadGUI is installed correctly:

.. code-block:: python

    import badgui as bg
    print(bg.__version__)

System Dependencies
-------------------

For generated Vue.js projects, you'll need:

**Node.js and npm**::

    # Ubuntu/Debian
    curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
    sudo apt-get install -y nodejs

    # macOS
    brew install node

    # Windows
    # Download from https://nodejs.org/

**Verify Node.js installation**::

    node --version
    npm --version

Troubleshooting
---------------

**ImportError: No module named 'badgui'**
    Make sure BadGUI is installed in the correct Python environment.

**Command 'npm' not found**
    Install Node.js which includes npm.

**Permission denied errors**
    Use ``pip install --user badgui`` to install in user directory.