https://github.com/telegram-mini-apps/telegram-apps

Made from scratch TypeScript packages, examples and documentation you will surely need to start developing on Telegram Mini Apps.
https://github.com/telegram-mini-apps/telegram-apps

javascript node telegram telegram-mini-apps typescript

Last synced: 6 days ago
JSON representation

Made from scratch TypeScript packages, examples and documentation you will surely need to start developing on Telegram Mini Apps.

• Host: GitHub
• URL: https://github.com/telegram-mini-apps/telegram-apps
• Owner: Telegram-Mini-Apps
• License: mit
• Created: 2022-11-07T18:52:11.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-12-17T22:07:15.000Z (7 days ago)
• Last Synced: 2024-12-17T23:04:48.632Z (7 days ago)
• Topics: javascript, node, telegram, telegram-mini-apps, typescript
• Language: TypeScript
• Homepage: https://docs.telegram-mini-apps.com/
• Size: 15.7 MB
• Stars: 761
• Watchers: 16
• Forks: 216
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[code-badge]: https://img.shields.io/badge/source-black?logo=github

# @telegram-apps

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

Mono-repository, containing all the packages, connected with comfortable and safe TypeScript

development on Telegram Mini Apps platform.

## Getting Started

A great starting point for learning about the platform is the community-built [documentation](https://docs.telegram-mini-apps.com). 

Additionally, the official Telegram [platform documentation](https://core.telegram.org/bots/webapps) can 

provide valuable insights and a different perspective on the platform.

Before diving into development, it’s also advisable to explore the available 

[libraries](https://docs.telegram-mini-apps.com/packages/telegram-apps-create-mini-app) for 

both client-side and backend development to gain a better understanding of the tools at your

disposal.

> [!WARNING]

> Working with `@telegram-apps` packages, you **must not** use the Telegram library - `telegram-web-app.js`.

> Using both `@telegram-apps` packages and `telegram-web-app.js` will surely lead to bugs.

## Why not Telegram SDK

Why bother creating a project like `@telegram-apps` when there are existing solutions from the developers

who own the platform? The answer is rather simple: the currently provided solution (SDK) does not

seem to meet the required minimum quality standards. Of course, the term 'quality' is rather

specific and subjective, but this section should make it more objective.

This project was born during the research of a solution provided by

Telegram - [telegram-web-app.js](https://telegram.org/js/telegram-web-app.js), which is considered

the only existing official SDK for Telegram Mini Apps by Telegram. Therefore, all the points

described in this section will be related to this package.

Because of the large section size, the complete motivation description has been moved to a [separate

document](./MOTIVATION.md).

## Contribution

Any contribution is appreciated. To start contributing, please, follow

the [Contribution Guidelines](./CONTRIBUTING.md).