⚠️⚠️⚠️ UNMAINTAINED ⚠️⚠️⚠️

Unfortunately, nobody who uses NestJS is excited enough about it to maintain this project.

Also, none of the core grammY maintainers is interested in working with NestJS. You can try to use this source code as-is, but do not expect any fixes (let alone new features).

If you want to take over, you simply need to convince us that you will stay around for more than a few months. We might then give you maintainer rights and remove this warning.

Until then, you probably should integrate grammY yourself.

grammY port of NestJS Telegraf

:information_source: This project would not be possible without the help and assistance of Aleksandr Bukhalo and the fantastic bukhalo/nestjs-telegraf project.

This project was generated using Nx.

🔎 Smart, Fast and Extensible Build System

⚠️ ALPHA STATUS DISCLAIMER

This project is both my first grammY plugin and first NestJS project as well -- please be patient -- @drmikecrowe

Alpha Status Implications

Alpha testers are needed to guide the implementation requirements needed for production deployments
As a pre-release, the API will likely change -- be prepared for breaking changes as we develop the optimal solution

Pre-Release Action Items

[ ] Finish setting up nx build/release of @grammyjs/nest including permission delegation
[ ] Finalize decorator API functions and documentation
[ ] Determine node version support and limitations
[ ] Testing, Testing, Testing (need unit testsgram)

Testing

To test out this repo, the following process is recommended until released:

Clone the repo
Run nx g @nrwl/nest:app mytestapp
Copy .env.example to .env and fill in with the appropriate information (leave BOT_INFO blank at first -- you will see a debug log showing how to fill it out in the future)
Run nx run mytestapp:serve to run your app (or use the Nx Console from VS Code).

Reference nestjs-grammy normally, and it will pull in the source code from the package.

The packages/sample-echo-bot is fully functioning and can be run with a bot token set in the environment

Projects Included

@grammyjs/nest - The NestJS / grammY plugin source code
sample-echo-bot - a sample echo-bot written in NestJS
sample-firebase-bot - the echo-bot written in NestJS using Firebase Functions for a serverless implementation

Building

To build:

yarn nx run grammy-nestjs:build

Deploying

To deploy:

yarn nx run grammy-nestjs:publish

Firebase Emulation

:warning: Firebase Emulation Only You may need to link @grammyjs/nestjs to this project. For example:

nx run grammy-nestjs:build
pushd dist/packages/grammy-nestjs/
yarn link
popd
yarn link @grammyjs/nestjs

Nestjs

Install / Use

README