Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fyko/export-api

A gRPC service to export Discord channels as HTML documents
https://github.com/fyko/export-api

csharp discord dotnet export grpc typescript

Last synced: 3 months ago
JSON representation

A gRPC service to export Discord channels as HTML documents

Host: GitHub
URL: https://github.com/fyko/export-api
Owner: Fyko
License: mit
Created: 2020-03-21T04:04:15.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2023-01-13T19:40:17.000Z (about 2 years ago)
Last Synced: 2024-09-15T21:59:19.499Z (4 months ago)
Topics: csharp, discord, dotnet, export, grpc, typescript
Language: C#
Homepage: https://fyko.github.io/export-api/
Size: 2.57 MB
Stars: 14
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # 📥 Discord Channel Exporter API

> A gRPC service to create HTML exports of Discord text-channels.  

[![Docs](https://img.shields.io/badge/%F0%9F%93%96-Documentation-informational)](https://fyko.github.io/export-api/docs/intro)

[![License](https://img.shields.io/github/license/fyko/export-api)](https://github.com/fyko/export-api/blob/master/LICENSE.md)

[![Test](https://github.com/Fyko/export-api/workflows/Test/badge.svg)](https://github.com/Fyko/export-api/actions?query=workflow%3ATest)

[![Docker Pulls](https://img.shields.io/badge/-Docker%20Image-grey?logo=docker)](https://github.com/Fyko/export-api/pkgs/container/export-api)

[![Ko-fi Donate](https://img.shields.io/badge/kofi-donate-brightgreen.svg?label=Donate%20with%20Ko-fi&logo=ko-fi&colorB=F16061&link=https://ko-fi.com/carterh&logoColor=FFFFFF)](https://ko-fi.com/carterh)  

## Usage

### Docker Image

The Export API can be found on the [GitHub Container Registry](https://pkg.github.com) at [`fyko/export-api`](https://github.com/Fyko/export-api/pkgs/container/export-api).  

```sh

docker run -p yourport:80 --rm -it ghcr.io/fyko/export-api

```

or with Compose

```yaml

services:

  exportapi:

    image: ghcr.io/fyko/export-api

    ports:

      - "yourport:80"

    expose:

      - "yourport"

```  

### Calling the gRPC API

- [Documentation](https://fyko.github.io/export-api/docs/api-versions/gRPC)

## Thanks

This services utilizes [`Tyrrrz/DiscordChatExporter`](https://github.com/Tyrrrz/DiscordChatExporter) for exporting channels.