telegram-tt/README.md

# Telegram Web Z

This project won the first prize 🥇 at [Telegram Lightweight Client Contest](https://contest.com/javascript-web-3) and now is an official Telegram client available to anyone at [web.telegram.org/z](https://web.telegram.org/z).

According to the original contest rules, it has nearly zero dependencies and is fully based on its own [Teact](https://github.com/Ajaxy/telegram-tt/tree/master/src/lib/teact) framework (which re-implements React paradigm). It also uses a custom version of [GramJS](https://github.com/gram-js/gramjs) as an MTProto implementation.

The project incorporates lots of technologically advanced features, modern Web APIs and techniques: WebSockets, Web Workers and WebAssembly, multi-level caching and PWA, voice recording and media streaming, cryptography and raw binary data operations, optimistic and progressive interfaces, complicated CSS/Canvas/SVG animations, reactive data streams, and so much more.

Feel free to explore, provide feedback and contribute.

## Local setup

```sh
mv .env.example .env

npm i
```

Obtain API ID and API hash on [my.telegram.org](https://my.telegram.org) and populate the `.env` file.

## Dev mode

```sh
npm run dev
```

### Invoking API from console

Start your dev server and locate GramJS worker in console context.

All constructors and functions available in global `GramJs` variable.

Run `npm run gramjs:tl full` to get access to all available Telegram requests.

Example usage:
``` javascript
await invoke(new GramJs.help.GetAppConfig())
```

## Bug reports and Suggestions
If you find an issue with this app, let Telegram know using the [Suggestions Platform](https://bugs.telegram.org/c/4002).
Update README.md 2021-04-16 16:51:22 +02:00			`# Telegram Web Z`
Initial commit 2021-04-09 12:29:59 +02:00
Follow-up 2021-08-21 12:46:46 +02:00			`This project won the first prize 🥇 at [Telegram Lightweight Client Contest](https://contest.com/javascript-web-3) and now is an official Telegram client available to anyone at [web.telegram.org/z](https://web.telegram.org/z).`
[Dev] Add project description to README 2021-08-21 12:33:28 +02:00
Update README.md 2021-08-22 14:22:55 +02:00			`According to the original contest rules, it has nearly zero dependencies and is fully based on its own [Teact](https://github.com/Ajaxy/telegram-tt/tree/master/src/lib/teact) framework (which re-implements React paradigm). It also uses a custom version of [GramJS](https://github.com/gram-js/gramjs) as an MTProto implementation.`
[Dev] Add project description to README 2021-08-21 12:33:28 +02:00
			`The project incorporates lots of technologically advanced features, modern Web APIs and techniques: WebSockets, Web Workers and WebAssembly, multi-level caching and PWA, voice recording and media streaming, cryptography and raw binary data operations, optimistic and progressive interfaces, complicated CSS/Canvas/SVG animations, reactive data streams, and so much more.`

			`Feel free to explore, provide feedback and contribute.`

Initial commit 2021-04-09 12:29:59 +02:00			`## Local setup`

			```sh
			`mv .env.example .env`

			`npm i`
			```

			Obtain API ID and API hash on [my.telegram.org](https://my.telegram.org) and populate the `.env` file.

			`## Dev mode`

			```sh
			`npm run dev`
			```

[Dev] Allow invoking Telegram API from console (#1346) 2021-08-03 00:31:05 +02:00			`### Invoking API from console`

			`Start your dev server and locate GramJS worker in console context.`

			All constructors and functions available in global `GramJs` variable.

			Run `npm run gramjs:tl full` to get access to all available Telegram requests.

			`Example usage:`
			``` javascript
			`await invoke(new GramJs.help.GetAppConfig())`
			```

			`## Bug reports and Suggestions`
Update README.md 2021-04-16 16:51:22 +02:00			`If you find an issue with this app, let Telegram know using the [Suggestions Platform](https://bugs.telegram.org/c/4002).`