Discord Service Setup and Running Instructions

This document provides instructions on how to set up and run the Go project using the provided Makefile commands.

Requirements

• Go 1.18+
• Make
• Air (for make air)
• Ngrok (for make ngrok)

Ensure you have these dependencies installed before running the commands.

Prerequisites

Before running the project, ensure that you have the following installed:

• Go 1.18+: The Go programming language (required to run and build the project).
• Air: A live-reloading tool for Go that will automatically restart the project on file changes.
• Ngrok: A tool to create a public URL for your local development server (useful for testing webhooks or exposing services to the internet).
• Make: A build automation tool used to manage tasks defined in the Makefile.

Installation

1. Install Go

   If you don't have Go installed, follow the official guide to install it:Go Installation Guide.

2. Install Make

   To install Make, follow the installations steps from here based on your OS:

   a. For Mac/Linux - Make Installation Guide.

   b. For Windows - Install choco

   Then run below command

      choco install make

3. Install Ngrok To install Ngrok, follow the installation steps here: Ngrok Installation Guide.

4. Install Air To install Air, follow the installation steps here: Air Installation Guide

Discord Bot Setup

• Refer to Setup

Setup env

1. Create .env file in root directory
2. Copy .env.example content in .env and replace with correct value

      PORT = "8999" # Default :8999
      DISCORD_PUBLIC_KEY = "<DISCORD_PUBLIC_KEY>" # Add the correct value from bot setup
      GUILD_ID = "<DISCORD_GUILD_ID>" # Add the discord server id
      BOT_TOKEN = "<BOT_TOKEN>" # Add the correct value from bot setup
      QUEUE_URL = "amqp://localhost" # Default :amqp://localhost
      ENV = "development" # Other: production, staging
      QUEUE_NAME = "DISCORD_QUEUE"  #Default: "DISCORD_QUEUE"

Start RabbitMQ with Docker

Ensure Docker is installed and running on your machine.

1. Navigate to the project directory.
2. Start RabbitMQ Container using below command

   docker compose up rabbitmq
   docker compose up -d rabbitmq # To run container in background

3. Verify that RabbitMQ is running by accessing the management interface at http://localhost:15672. The default username and password are both guest.

Start Server with Docker

1. Start server using below command

   docker compose up server
   docker compose up -d server # To run the server in background

2. Verify that Server is running by making an http request at http://localhost:8080/health.

Start the Server without Docker

1. Install Packages

   go mod download

2. Verify Packages If it's your first time running the project, ensure all dependencies are set up:

   go mod tidy

3. Running the Project

   go run .

4. Running the Project Using Air

   air

5. Verify that Server is running by making an http request at http://localhost:8999/health.

Start Server and RabbitMq with Docker

   docker compose up 
   docker compose up -d # To run server and rabbitmq container

1. Verify that RabbitMQ is running by accessing the management interface at http://localhost:15672. The default username and password are both guest.
2. Verify that Server is running by making an http request at http://localhost:8080/health.

Running the Project Using Make

You can run the project using the Makefile, which provides several commands for various tasks. Below are the steps to run the project:

1. Install Packages

   make download

2. Verify Packages If it's your first time running the project, ensure all dependencies are set up:

   make tidy

3. Running the Project

   make run

4. Running the Project Using Air

   make air

Other Commands Usage

1. To run tests:

   make test #or go list ./... | grep -v "/config$$" | grep -v "/routes$$" | xargs go test -v

2. To generate a coverage report:

   make coverage #or go list ./... | grep -v "/config$$" | grep -v "/routes$$" | xargs go test -v -coverprofile=coverage.out

3. To automatically re-run the application on changes:

   make air #or air

4. To clean up the generated files:

   make clean #or rm -rf coverage coverage.out coverage.html