README.md

Stellar Discord Bot

Table of Contents

• Description
• Project Setup
• Compile and Run
• Run Tests
• Run Locally with Discord
• Docker
• License

Description

Nest TypeScript Discord Bot for the Stellar Development Foundation.

Check out the Discord here Stellar Discord.

Project Setup

Prerequisites

• Node.js >= 20.x
• pnpm
• Docker (optional, for containerized deployment)

Installation

$ pnpm install

Compile and run

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

Run tests

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

Run Locally with Discord

Using ngrok

ngrok http 3000

cloudflared tunnel --url http://localhost:3000

Docker

Build image locally

docker build --platform linux/amd64 -t devrel-discord-bot .

Push to DockerHub

docker tag devrel-discord-bot:latest chrisstellar/devrel-discord-bot:latest
docker push chrisstellar/devrel-discord-bot:latest

License

Nest is MIT licensed.