Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/morethanwords/tweb
Telegram Web K, GPL v3
https://github.com/morethanwords/tweb
javascript progressive-web-app single-page-app telegram webapp
Last synced: about 5 hours ago
JSON representation
Telegram Web K, GPL v3
- Host: GitHub
- URL: https://github.com/morethanwords/tweb
- Owner: morethanwords
- License: gpl-3.0
- Created: 2020-02-06T15:36:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-09T10:32:51.000Z (about 1 month ago)
- Last Synced: 2024-12-05T03:35:14.388Z (7 days ago)
- Topics: javascript, progressive-web-app, single-page-app, telegram, webapp
- Language: TypeScript
- Homepage: https://web.telegram.org/k/
- Size: 1.14 GB
- Stars: 1,872
- Watchers: 67
- Forks: 601
- Open Issues: 142
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - morethanwords/tweb - Telegram Web K, GPL v3 (TypeScript)
- awesome-telegram - Telegram Web, Version K
- awesome-telegram - Telegram Web, Version K
README
## Telegram Web K
Based on Webogram, patched and improved. Available for everyone here: https://web.telegram.org/k/
### Developing
Install dependencies with:
```lang=bash
pnpm install
```
This will install all the needed dependencies.
#### Running web-server
Just run `pnpm start` to start the web server and the livereload task.
Open http://localhost:8080/ in your browser.
#### Running in production
Run `node build` to build the minimized production version of the app. Copy `public` folder contents to your web server.
### Dependencies
* [BigInteger.js](https://github.com/peterolson/BigInteger.js) ([Unlicense](https://github.com/peterolson/BigInteger.js/blob/master/LICENSE))
* [pako](https://github.com/nodeca/pako) ([MIT License](https://github.com/nodeca/pako/blob/master/LICENSE))
* [cryptography](https://github.com/spalt08/cryptography) ([Apache License 2.0](https://github.com/spalt08/cryptography/blob/master/LICENSE))
* [emoji-data](https://github.com/iamcal/emoji-data) ([MIT License](https://github.com/iamcal/emoji-data/blob/master/LICENSE))
* [twemoji-parser](https://github.com/twitter/twemoji-parser) ([MIT License](https://github.com/twitter/twemoji-parser/blob/master/LICENSE.md))
* [rlottie](https://github.com/rlottie/rlottie.github.io) ([MIT License](https://github.com/Samsung/rlottie/blob/master/licenses/COPYING.MIT))
* [fast-png](https://github.com/image-js/fast-png) ([MIT License](https://github.com/image-js/fast-png/blob/master/LICENSE))
* [opus-recorder](https://github.com/chris-rudmin/opus-recorder) ([BSD License](https://github.com/chris-rudmin/opus-recorder/blob/master/LICENSE.md))
* [Prism](https://github.com/PrismJS/prism) ([MIT License](https://github.com/PrismJS/prism/blob/master/LICENSE))
* [Solid](https://github.com/solidjs/solid) ([MIT License](https://github.com/solidjs/solid/blob/main/LICENSE))
* [TinyLD](https://github.com/komodojp/tinyld) ([MIT License](https://github.com/komodojp/tinyld/blob/develop/license))
* [libwebp.js](https://libwebpjs.appspot.com/)
* fastBlur
### Debugging
You are welcome in helping to minimize the impact of bugs. There are classes, binded to global context. Look through the code for certain one and just get it by its name in developer tools.
Source maps are included in production build for your convenience.
#### Additional query parameters
* **test=1**: to use test DCs
* **debug=1**: to enable additional logging
* **noSharedWorker=1**: to disable Shared Worker, can be useful for debugging
* **http=1**: to force the use of HTTPS transport when connecting to Telegram servers
Should be applied like that: http://localhost:8080/?test=1
### Troubleshooting & Suggesting
If you find an issue with this app or wish something to be added, let Telegram know using the [Suggestions Platform](https://bugs.telegram.org/c/4002).
### Licensing
The source code is licensed under GPL v3. License is available [here](/LICENSE).