Skip to content

Commit

Permalink
Glaximini submission
Browse files Browse the repository at this point in the history
This app allows the user to create animated stickers and share them on Telegram.
  • Loading branch information
mbasaglia committed Oct 10, 2023
1 parent 6ed01d9 commit c54f5b9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 17 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
Event Telegram Mini-App Demo
============================
Glaximini
=========

Mini Apps is a Python framework to create [Telegram Mini Apps](https://core.telegram.org/bots/webapps).
This app allows the user to create animated stickers and share them on Telegram.

There are some built-in apps that showcase the features of both this framework and the mini apps feature on Telegram:
Live instance: [@GlaximiniBot](https://t.me/GlaximiniBot).

_Tic Tac Toe_ allows you to play tic tac toe (also known as naughts and crosses) against another player on Telegram.
More info in the [Glaximini app page](./docs/apps/glaximini.md).

_Mini Events_ is a demo app that shows a list of events the user can attend.
Full documentation is available on [Read the Docs](https://mini-apps.readthedocs.io/en/latest/).

_Glaximini_ is a more complex app that allows the user to create animated stickers and share them on Telegram.

Full documentation is available on [Read the Docs](https://mini-apps.readthedocs.io/en/latest/).
## Limitations

Currently it's limited to one animation per user, and the feature support is rather limited.


Set Up
Expand Down
15 changes: 6 additions & 9 deletions docs/installation/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ If you are planning to run from docker, somewhere in your home directory will al


There are [multiple apps](../apps/index.md) available, this guide will set up
the [Tic Tac Toe](../apps/tic_tac_toe.md) app, but you can easily add more apps.
the [Glaximini](../apps/glaximini.md) app, but you can easily add more apps.


## Bot Setup

Talk to [BotFather](https://t.me/BotFather) and create a bot, keep note of the token it gives you as it's needed later.

On that bot enable the _Menu Button_ under _Bot Settings_, and give it `https://miniapps.example.com/tic_tac_toe/` as URL.
On that bot enable the _Menu Button_ under _Bot Settings_, and give it `https://miniapps.example.com/glaximini/` as URL.

You need to create a new app on that bot (`/newapp`) with the same URL as the button, and `tic_tac_toe` short name.
You need to create a new app on that bot (`/newapp`) with the same URL as the button, and `glaximini` short name.

Finally, enable inline mode with `/setinline`.

Expand Down Expand Up @@ -79,11 +79,10 @@ with the following:
"port": 2536
},
"apps": {
"tic_tac_toe": {
"class": "mini_apps.apps.tic_tac_toe.TicTacToe",
"glaximini": {
"class": "mini_apps.apps.glaximini.app.Glaximini",
"bot-token": "(your bot token)",
"short-name": "tic_tac_toe",
"url": "https://miniapps.example.com/tic_tac_toe/"
"url": "https://miniapps.example.com/glaximini/"
}
},
"api-id": "(your api id)",
Expand All @@ -96,8 +95,6 @@ The values for `api-id` and `api-hash` can be obtained from <https://my.telegram

`url` should be the public URL of your mini app, the same you specified on BotFather.

`short-name` is the app short name that you set on BotFather with `/newapp`.

If you want to run on the Telegram test server, add the following to the JSON,
with the values from <https://my.telegram.org/apps>.

Expand Down

0 comments on commit c54f5b9

Please sign in to comment.