Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add NestJS docs #1016

Closed
wants to merge 2 commits into from
+33 −0
Closed

Add NestJS docs #1016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed1fffc
Add NestJS dummy page
KnorpelSenf Mar 20, 2024
685079f
Merge branch 'main' into nestjs
KnorpelSenf Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions site/docs/.vitepress/configs/locales/en.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,12 @@ const pluginOfficial = {
// do not add the following line to translations:
activeMatch: "^(/plugins/router|/ref/router/)$",
},
{
text: "NestJS (nestjs)",
link: "/plugins/nestjs",
// do not add the following line to translations:
activeMatch: "^(/plugins/nestjs|/ref/nestjs/)$",
},
{
text: "Emoji (emoji)",
link: "/plugins/emoji",
Expand Down
27 changes: 27 additions & 0 deletions site/docs/plugins/nestjs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
prev: false
next: false
---

# NestJS Integration (`nestjs`)

This plugin provides an integration of a grammY bot into a [NestJS](https://nestjs.com/) application.

## Installation

Run

```sh
npm install @grammjys/nestjs
```

to install the plugin in your existing NestJS project.

## Usage

todo
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NarHakobyan please add a short example of a basic usage of this plugin by editing this file. It does not have to be anything fancy, just a simple echo bot to get people started maybe. I think it is fair to require familiarity with NestJS from our readers, so they should already have a working NestJS project when they get to this step.


## Plugin Summary

- Name: `nestjs`
- [Source](https://github.com/grammyjs/nestjs)
Loading