Giter VIP home page Giter VIP logo

tma.js's Introduction

@tma.js

Mono-repository, containing all the packages, connected with comfortable and safe TypeScript development on Telegram Mini Apps platform. To learn more about specific packages, follow their own documentations.

โš ๏ธ Working with @tma.js packages, you must not install SDK from Telegram presented by single file - telegram-web-app.js. Using both @tma.js packages and telegram-web-app.js will surely lead to bugs.

Templates

The list of Mini Apps templates, using different frontend technologies:

Packages

sdk-npm-badge Size code-badge

Made from scratch TypeScript library for seamless communication with Telegram Mini Apps functionality.

The code of this library is designed to simplify the process of developers interacting with Telegram Mini Apps. It consists of several individual components, each responsible for a specific aspect of the Telegram Mini Apps ecosystem.

Before you begin using the SDK, we highly recommend familiarizing yourself with the Telegram Mini Apps documentation to grasp the fundamental concepts of the platform.

sdk-react-npm-badge Size code-badge

React JS bindings for client SDK. Includes hooks, components and utilities for comfortable usage of React JS on the Telegram Mini Apps platform.

sdk-solid-npm-badge Size code-badge

Solid JS bindings for client SDK. Includes hooks, components and utilities for comfortable usage of Solid JS on the Telegram Mini Apps platform.

init-data-node-npm-badge Size code-badge

The package provides utilities to work with the initialization data of Telegram Mini Apps on the server side. To learn more about the initialization data and its usage, please refer to the documentation.

solid-router-integration-npm-badge Size code-badge

Telegram Mini Apps Navigator integration for @solidjs/router.

Why not Telegram SDK

Why bother creating a project like @tma.js 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 appreaciated. To start contributing, please, follow the Contribution Guidelines.

tma.js's People

Contributors

heyqbnk avatar github-actions[bot] avatar twa-bot avatar 0x009922 avatar kubk avatar eugeniakirs avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.