Skip to content

Commit

Permalink
docs: add readme for the project
Browse files Browse the repository at this point in the history
  • Loading branch information
Sergey Gutskal authored and Sergey Gutskal committed Oct 10, 2023
1 parent 2399ac5 commit c66dafc
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# GADGETS INFO MINI APP

See demo here: https://t.me/gadgets_info_bot

## Description

Gadgets info mini app is a place where you can find all technical info about any gadget and also compare them to each other.

## Current features

- search gadgets through mock and filter them by name or brand data
- see gadget detailed technical info
- compare technical info between two selected gadgets

## Next features

- build and integrate backend
- improve UI/UX
- integrate `docker`

## Setup guide

**NOTE: To setup mini app started on local machine must be used test environment. Read more about [here](https://core.telegram.org/bots/webapps#testing-mini-apps)**

- Build and deploy the app to any static host or run it on local machine following the instruction - [README.md](./app/README.md)
- Open [BotFather](https://t.me/BotFather)
- Create a bot using `/newbot` command
- Link the app url to the bot menu button following next steps:
1. Use `/mybots` command
2. Select created bot > `Bot settings` > `Menu button` > `Configure menu button`
3. Follow bot instructions
- Done! Open your bot and enjoy!

0 comments on commit c66dafc

Please sign in to comment.