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

# Hex Web

Welcome to the **Hex Web** setup guide! This document will walk you through configuring your system and preparing Hex Web for use.

***

### Prerequisites

Before starting, ensure you have the following installed on your system:

1. **Node.js** (v14 or higher)
2. **npm** (Node Package Manager)
3. A valid **license key**

***

### Step 1: Install Dependencies

Hex Web requires several core dependencies to function. The setup process will automatically handle missing packages, but you can install them manually if needed:

```bash
npm install colors chalk figlet inquirer js-yaml
```

***

### Step 2: Run the Setup Wizard

The setup wizard will guide you through the configuration process. To start the wizard, run the following command:

```bash
node setup.js
```

During the wizard, you’ll be prompted to:

1. Enter your **license key**
2. Configure authentication settings
3. Set up system details (e.g., port number, API keys)
4. Define site and store settings
5. Customize the theme colors
6. Provide contact and service details

***

### Configuration Options

#### Authentication

* **License Key:** Enter the license key provided during purchase or registration.
* The system will verify your license key. If authentication fails, you’ll be prompted to re-enter a valid key.

#### System Settings

* **Port Number:** The port on which the application will run (default: `3000`).
* **SendGrid API Key:** Used for sending emails.
* **From Email:** Verified email address for outgoing messages.
* **To Email:** Recipient email address for test communications.

#### Theme Colors

Customize the appearance of Hex Web:

* **Primary Red:** Default: `#ff1744`
* **Dark Red:** Default: `#d50000`
* **Black:** Default: `#121212`
* **Dark Gray:** Default: `#1e1e1e`
* **Card Background:** Default: `#1a1a1a`
* **Text Primary:** Default: `#ffffff`
* **Text Secondary:** Default: `#b3b3b3`

#### Site Configuration

* **Site Name:** Name of your site (default: `Hex-Web`)
* **Tagline:** Short description of the site (default: `Crafting Digital Excellence`)
* **Description:** Detailed site description.
* **Site URL:** URL where the site will be hosted.

#### Contact Details

* **Email:** Contact email for inquiries.
* **Phone:** Contact phone number.
* **Address:** Physical or business address.

#### Store Configuration

* **Store Title:** Default: `Our Products`
* **Store Description:** Default: `Explore our premium digital solutions`

***

### Saving Configuration

Once completed, your configuration will be saved in a `config.yml` file under the `config` directory. This file includes all your settings in YAML format.

If `config.yml` already exists, the wizard will not overwrite it unless you delete the file manually.

***

### Starting Hex Web

To start the Hex Web application, use the following command:

```bash
npm start
```

Your instance will now be accessible at `http://localhost:<port>`.

***

### Troubleshooting

* **Dependency Issues:** Run `npm install` to ensure all required packages are installed.
* **Authentication Errors:** Verify your license key and network connectivity.
* **Configuration Errors:** Delete `config.yml` and re-run the setup wizard.

***

Thank you for choosing Hex Web! For support, contact our team or visit our documentation.