https://github.com/geekswamp/miriel

:elf_woman: Miriel is Telegram bot based on OpenAI
https://github.com/geekswamp/miriel

openai telegram-bot typescript

Last synced: about 1 hour ago
JSON representation

:elf_woman: Miriel is Telegram bot based on OpenAI

• Host: GitHub
• URL: https://github.com/geekswamp/miriel
• Owner: geekswamp
• License: mit
• Created: 2022-12-28T05:27:37.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-30T10:32:11.000Z (about 2 years ago)
• Last Synced: 2025-01-17T20:53:03.112Z (3 days ago)
• Topics: openai, telegram-bot, typescript
• Language: TypeScript
• Homepage: https://t.me/miriel_the_bot
• Size: 42 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# :elf_woman: Miriel

[Miriel] is a Telegram bot developed based on [OpenAI]. Miriel can help you with coding, stories, and more.

# Installation

## System Requirements

1. [NodeJs] v14.x or later

2. [Yarn] or [NPM]

3. Telegram bot. You can create a new Telegram bot from [Bot Father]

## Environment Variables

- `BOT_TOKEN` - Your Telegram bot token.

- `OPENAI_API_KEY` - Your OpenAI API key. You can create a new API key from [this].

## Local Launch

1. Clone this repository: `https://github.com/arifai/miriel.git`

2. Go to `miriel` folder with `cd miriel`

3. Copy file `.env.example` to `.env`

4. Run `yarn install` or `npm install`

5. Run with `yarn start` or `yarn dev` for development mode

## License

[MIT]

[Miriel]: https://t.me/miriel_the_bot

[OpenAI]: https://openai.com

[NodeJs]: https://nodejs.org

[Yarn]: https://yarnpkg.com

[NPM]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

[Bot Father]: https://t.me/botfather

[this]: https://beta.openai.com/account/api-keys

[MIT]: https://github.com/arifai/miriel/blob/main/LICENSE