Skip to content

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

License

Notifications You must be signed in to change notification settings

Telegram-Mini-Apps/telegram-apps

Repository files navigation

@telegram-apps

Commitizen friendly

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. Additionally, the official Telegram platform documentation can provide valuable insights and a different perspective on the platform.

Before diving into development, it’s also advisable to explore the available libraries 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, 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.

Contribution

Any contribution is appreciated. To start contributing, please, follow the Contribution Guidelines.