https://github.com/ghashtag/neuro-coder

https://github.com/ghashtag/neuro-coder

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ghashtag/neuro-coder
• Owner: gHashTag
• License: mit
• Created: 2024-09-22T04:41:20.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-16T16:31:18.000Z (3 months ago)
• Last Synced: 2024-10-18T13:13:05.038Z (3 months ago)
• Language: TypeScript
• Homepage: https://neuro-coder.vercel.app
• Size: 782 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grammY Vercel boilerplate

[grammY](https://grammy.dev/) boilerplate to develop and host telegram bots on [Vercel](https://vercel.com/).

## Features

- Typescript support

- Linting and formatting preconfigured

- Development friendly environment with Nodemon

## Development

```bash

# Copy the .env example and change the BOT_TOKEN to match yours

$ cp .env.example .env

# Install the dependencies

$ npm install

# Run the development environment

$ npm run dev

```

## Deployment

#### Terminal

```bash

# Install vercel cli if you don't have it yet

$ npm i -g vercel

# Deploy the project

$ vercel --prod

```

#### Vercel

On your project's page, go to Settings > Environment Variables and add the following variables:

| Name        | Value            |

| ----------- | ---------------- |

| `BOT_TOKEN` | _your bot token_ |

> You can also set the webhook URL manually accessing `https://api.telegram.org/bot/setWebhook?url=` on your browser

Finally, you should see a "Hello, world!" from the bot when typing `/hello` in chat.

## Using Express instead of Vercel's API

By default `grammy-vercel-boilerplate` does not use extra dependencies, but in case you want to use Express, first add it as a dependency

```sh

$ npm install express

```

And then edit the contents of `api/index.ts` to

```js

require("../src/index")

import express from "express"

import { webhookCallback } from "grammy"

import bot from "../src/core/bot"

const app = express()

app.use(express.json())

app.use(`/api/index`, webhookCallback(bot))

export default app

```

## Contributing

Pull requests are welcome. If you have any suggestions, you can also create an [issue](https://github.com/neumanf/grammy-vercel-boilerplate/issues).

## License

[MIT](https://choosealicense.com/licenses/mit/)