> For the complete documentation index, see [llms.txt](https://revolution-4.gitbook.io/revolution-or-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://revolution-4.gitbook.io/revolution-or-docs/resources/rv_gui.md).

# rv\_gui

### :bulb:Getting Started

1. First you need to clone the git repo [rv\_gui](https://github.com/programmernb-ctrl/rv_gui) into your fivem resources directory

```bash
cd /path/to/your/fivem/resources
git clone https://github.com/programmernb-ctrl/rv_gui.git .
```

2. Install all of the dependencies to build the resource

```bash
cd rv_gui
bun install
```

3. Now install the dependencies for the webview

```bash
cd ./rv_gui/gui
bun install
```

4. Now go to the root directory of the rv\_gui resource and execute the command you need in a terminal

```
bun run build     - build server files
bun run build:web - build webview
bun run build:dev - build everything
bun run dev       - watch everything
bun run watch     - watch server files
bun run watch:web - watch webview
```

### :file\_folder: Structure

To help you navigate the project's directory structure, here's a brief overview of some key folders:

* **rv\_gui**: This is the main directory encompassing the entire project setup, including the webview and server components.
* **resource**: This folder contains the files we build with the commands, also the resource is started from this directory.
* **gui**: Inside this directory, you'll find the files related to the graphical user interface. This is where the webview interface is developed and maintained.
* **src**: The source folder houses the core codebase, including scripts and logic for the project's functionalities. All primary coding efforts are concentrated here and are later compiled to JS code