Getting Started

◈ Getting Started

This guide will help you set up your own instance of WordSeek. Whether you want to run it locally for development or host it for a community, follow these steps.

---

◈ Prerequisites

Before you begin, ensure you have the following installed and ready: ▪ Bun.js: The recommended runtime for WordSeek. Install Bun.
▪ PostgreSQL: A running instance of Postgres database.
▪ Redis: A running instance of Redis for caching and queues.
▪ Telegram Bot Token: Create a bot via @BotFather.

---

◈ Installation Steps

1. Clone the Repository

   git clone https://github.com/bisug/TG-WordGame
   cd TG-WordGame

2. Install Dependencies

   bun install

3. Configure Environment Variables Copy the example environment file and fill in your details:

   cp .env.example .env

   ▸ Key Variables to Set:

   • BOT_TOKEN: Your bot token from BotFather.
   • DATABASE_URL: Your Postgres connection string.
   • REDIS_URI: Your Redis connection string.
   • ADMIN_USERS: Your Telegram User ID (get it from @userinfobot).

4. Initialize the Database Run the migrations to create the necessary tables:

   bun run db:migrate

5. Start the Bot

   bun run start

   For development with auto-reload:

   bun run dev

---

◈ Basic Configuration

Once the bot is running, you should:

1. Start a chat with the bot and send /start.
2. Add the bot to a group and promote it to Admin (required for reading messages and managing topics).
3. Set up your game topics if using a Forum group with /setgametopic.

---

Next: For production hosting options, check the Deployment Guide.