An open API service indexing awesome lists of open source software.

https://github.com/stellar/devrel-discord-bot

Nest.js Discord Bot with deep, seamless integration to provide responsive support and improve DX.
https://github.com/stellar/devrel-discord-bot

Last synced: 4 months ago
JSON representation

Nest.js Discord Bot with deep, seamless integration to provide responsive support and improve DX.

Awesome Lists containing this project

README

          

Stellar Logo


Stellar Discord Bot

Build Status
License: MIT

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/anataliocs/stellar-discord-bot)

## Table of Contents

- [Description](#description)
- [Project Setup](#project-setup)
- [Compile and Run](#compile-and-run)
- [Run Tests](#run-tests)
- [Run Locally with Discord](#run-locally-with-discord)
- [Docker](#docker)
- [License](#license)

## Description

[Nest](https://github.com/nestjs/nest) TypeScript Discord Bot for
the [Stellar Development Foundation](https://stellar.org/).

Check out the Discord here [Stellar Discord](https://discord.com/invite/zVYdY3ktTn).

## Project Setup

### Prerequisites

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

### Installation

```bash
$ pnpm install
```

## Compile and run

```bash
# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod
```

## Run tests

```bash
# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov
```

## Health check

http://localhost:3000/health

## 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](https://github.com/nestjs/nest/blob/master/LICENSE).