Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mamal72/golyrics-telegram

A simple Telegram lyrics bot
https://github.com/mamal72/golyrics-telegram

api lyrics telegram telegram-bot

Last synced: 3 months ago
JSON representation

A simple Telegram lyrics bot

Host: GitHub
URL: https://github.com/mamal72/golyrics-telegram
Owner: mamal72
License: mit
Created: 2016-11-23T23:59:40.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2016-11-25T00:40:24.000Z (about 8 years ago)
Last Synced: 2024-06-20T10:58:12.436Z (7 months ago)
Topics: api, lyrics, telegram, telegram-bot
Language: Go
Size: 532 KB
Stars: 8
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![Go Report Card](https://goreportcard.com/badge/github.com/mamal72/golyrics-telegram)](https://goreportcard.com/report/github.com/mamal72/golyrics-telegram)
[![license](https://img.shields.io/github/license/mamal72/golyrics-telegram.svg)](https://github.com/mamal72/golyrics-telegram/blob/master/LICENSE)

# golyrics-telegram
A simple Telegram lyrics bot based on [golyrics](https://github.com/mamal72/golyrics).

There's a working demo running [here](https://telegram.me/GolyricsBot). I may stop it or not; No guaranty! 🤖

## Installation

```bash
go get github.com/mamal72/golyrics-telegram
```

## Usage

```bash
BOT_TOKEN=YOUR_BOT_TOKEN golyrics-telegram
```

> You can also export your `BOT_TOKEN` or set it in the `.env` file in the root of the project. There's an example `.env` file named `.env.example` with needed variable names there.

## Screenshot

## Development

1. Clone the repository.

1. Fill the needed variables in `.env.example` file.

1. Rename `.env.example` to `.env`.

1. Build or run the app.

## Ideas || Issues
Just fill an issue and describe it. I'll check it ASAP!

## Contribution

You can fork the repository, improve or fix some part of it and then send the pull requests back if you want to see them here. I really appreciate that. :heart:

## License
> MIT