Getting Started

This guide will walk you through installing, configuring, and running Holo Bridge.

Prerequisites

• Node.js 18 or higher
• npm or yarn package manager
• A Discord bot token

Installation

1. Clone the Repository

git clone https://github.com/your-repo/discord-web-bridge.git
cd discord-web-bridge

2. Install Dependencies

npm install

Configuration

Environment Variables

Copy .env.example to .env and fill in your values:

# Discord Bot Token (required)
# Get this from https://discord.com/developers/applications
DISCORD_TOKEN=your_discord_bot_token_here

# API Configuration
PORT=3000
API_KEY=your_secure_api_key_here

# Optional: Enable debug logging
DEBUG=false

Variable	Required	Description
DISCORD_TOKEN	Yes	Your Discord bot token
API_KEY	Yes	API key for authenticating requests
PORT	No	Server port (default: 3000)
DEBUG	No	Enable debug logging (default: false)

Running the Server

Development Mode

npm run dev

Production Mode

npm run build
npm start

Discord Bot Setup

Follow these steps to create a Discord bot and invite it to your server:

1. Go to the Discord Developer Portal
2. Click "New Application" and give it a name
3. Go to the "Bot" section in the left sidebar
4. Click "Add Bot" and confirm
5. Enable the following Privileged Gateway Intents:
   • Presence Intent
   • Server Members Intent
   • Message Content Intent
6. Click "Reset Token" to get your bot token and copy it to your .env file

Inviting the Bot

1. Go to the "OAuth2" → "URL Generator" section
2. Select the following scopes:
   • bot
   • applications.commands
3. Select the permissions your bot needs (Administrator for full access)
4. Copy the generated URL and open it in your browser
5. Select a server and authorize the bot

Testing the API

Once the server is running, you can test the API with curl:

# List all guilds
curl -H "X-API-Key: your_api_key" http://localhost:3000/api/guilds

Next Steps